Implement dry run functionality

[infoex-autowx.git] / README

diff --git a/README b/README
index a36125fb2c3d19e94008b12f057d798360f3f595..39ce7bc6283bbe59e0ca21a09946555ad4d5753a 100644 (file)
--- a/README
+++ b/README
@@ -17,13 +17,13 @@ terms.
 Installation
 ============
 
-It's recommended to use virtualenv and pip with this program. Here's a
-typical sequence of commands for a new setup:
+It's recommended to use venv and pip with this program. Here's a typical
+sequence of commands for a new setup:
 
 $ cd /path/to/src
-$ virtualenv venv
-$ . venv/bin/activate
-$ pip3 install -r requirements.txt
+$ python3 -m venv env
+$ . env/bin/activate
+$ pip install -r requirements.txt
 
 How to use it
 =============
@@ -35,15 +35,17 @@ This design allows you to run a separate program instance for each NRCS
 weather station from which you'd like to automate the importation of
 data into your InfoEx subscriber account.
 
-To run ad-hoc:
+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>
 
 Here's an example of a crontab(5) with two SNOTEL sites, each of which
-will run once per hour:
+will run once per hour (note that this will activate the virtual environment
+created earlier):
 
-2 * * * * /home/alv/infoex-autowx/infoex-autowx.py --config laurance-lake.ini
-4 * * * * /home/alv/infoex-autowx/infoex-autowx.py --config mud-ridge.ini
+2 * * * * /usr/bin/env bash -c 'cd /home/user/infoex-autowx && source env/bin/activate && ./infoex-autowx.py --config laurance-lake.ini'
+4 * * * * /usr/bin/env bash -c 'cd /home/user/infoex-autowx && source env/bin/activate && ./infoex-autowx.py --config mud-ridge.ini'
 
 Configuration File
 ==================