diff --git a/README.md b/README.md index 3d15961..43e87c7 100644 --- a/README.md +++ b/README.md @@ -70,14 +70,10 @@ The bot will consider an aircraft to be "circling" if: 2. The centroid of the last 3 minutes worth of positions must be more than 2.5 km away from all known airports. -3. The centroid must be located within the county of Los Angeles. - (This is just because I don't yet have airport data outside Los - Angeles County.) - -4. The aircraft must, at the moment of decision, be at an altitude of +3. The aircraft must, at the moment of decision, be at an altitude of 300 feet or more. -5. Once an aircraft is considered to be circling, it will be tweeted +4. Once an aircraft is considered to be circling, it will be tweeted about. It won't be eligible to be considered circling/tweeted about again until it stops circling and 30 minutes pass. @@ -160,6 +156,10 @@ more than once every 10 seconds. * **Do not run the script more often than once every 15 seconds, or adsbexchange.com will ban your IP.** +* **Do note that this brings up a test instance that is missing database + configuration necessary for tweeting.** + + ## Development @@ -168,3 +168,13 @@ To run a test watcher: ``` npx shadow-cljs watch script test ``` + +## Installation + +Once you're confident that you have everything set up correctly, decide what name your instance will have (e.g. "la" for Los Angeles) and run the following: + +``` +sudo ./install.sh la +``` + +This configure the proper directory tree, load up an aircraft database, install a skeletal systemd script, then configure a specific advisorycircular@la.service instance from your config.yaml and secrets.yaml. \ No newline at end of file