A few more README changes
authorAlexander Vasarab <alexander@wylark.com>
Wed, 1 Jul 2020 01:40:49 +0000 (18:40 -0700)
committerAlexander Vasarab <alexander@wylark.com>
Wed, 1 Jul 2020 01:40:49 +0000 (18:40 -0700)
README.md

index 3b442b56627a1541eab02fda9161885b43c2991d..edd134b8ddb6a5d4cfaeff58781d5c1f9ab9f8de 100644 (file)
--- a/README.md
+++ b/README.md
@@ -35,18 +35,26 @@ This design allows you to run a separate program instance for each NRCS
 or MesoWest weather station from which you'd like to automate the
 importation of data into your InfoEx subscriber account.
 
 or MesoWest weather station from which you'd like to automate the
 importation of data into your InfoEx subscriber account.
 
+To get started, copy the included example config file
+(`config.ini.example` in the root source directoy) and modify the values
+for your own use.
+
 To run ad-hoc (be sure to activate the virtual environment, as detailed in the
 Installation section):
 
 `./infoex-autowx.py --config path/to/config-file.ini [--dry-run] [--log-level debug|info|warning]`
 
 To run ad-hoc (be sure to activate the virtual environment, as detailed in the
 Installation section):
 
 `./infoex-autowx.py --config path/to/config-file.ini [--dry-run] [--log-level debug|info|warning]`
 
-**NOTE: Specifying --dry-run will also not clean up the generated CSV
-file.** This is so that you can debug any issues more easily.
+**NOTE: Specifying --dry-run will not clean up the generated CSV file.**
+This is so that you can more easily debug any issues that arise in the
+setup process.
 
 You can also specify `--log-level` as debug, info, warning. The
 
 You can also specify `--log-level` as debug, info, warning. The
-resultant log messages will try to be logged to journald, but if that's
-not available, they will be printed to stdout. This output can be
-helpful early on in the setup process.
+log messages produced by the program will try to be logged to journald,
+but if that's not available, they will be printed to stdout. This output
+can be helpful early on in the setup process.
+
+Automation
+----------
 
 Here's an example of a crontab(5) with two SNOTEL sites, each of which
 will run once per hour (note that this will activate the virtual environment
 
 Here's an example of a crontab(5) with two SNOTEL sites, each of which
 will run once per hour (note that this will activate the virtual environment
@@ -129,7 +137,7 @@ Once you've chosen your elements, combine all of their respective
 "elementCd" values into a comma-delimited string and put that into your
 configuration file as the `desired_data` value.
 
 "elementCd" values into a comma-delimited string and put that into your
 configuration file as the `desired_data` value.
 
-A complete example:
+A complete [station] section example:
 
 `[station]`  
 `type = nrcs`  
 
 `[station]`  
 `type = nrcs`  
@@ -165,12 +173,12 @@ you want to import data. Here are the steps to do that:
 
 https://developers.synopticdata.com/about/station-variables/
 
 
 https://developers.synopticdata.com/about/station-variables/
 
-The MesoWest API supports on-the-fly unit conversion, so that can be
-specified to infoex-autowx via the configuration option `units`. This
-can be either 'english' or 'metric', with 'english' meaning imperial
-units as used in the United States.
+The MesoWest API supports on-the-fly unit conversion. If desired, that
+can be specified to infoex-autowx via the configuration option `units`.
+This can be either 'english' or 'metric', with 'english' meaning
+imperial units as used in the United States.
 
 
-A complete example:
+A complete [station] section example:
 
 `[station]`  
 `type = mesowest`  
 
 `[station]`  
 `type = mesowest`