Add QuickStart instructions to README. #123
Conversation
README.md
Outdated
| python greenpithumb/greenpithumb.py \ | ||
| --poll_interval 15 \ | ||
| --photo_interval 240 \ | ||
| --config_file "C:\GreenPiThumb\greenpithumb\config.ini" \ |
There was a problem hiding this comment.
If they followed the install directions, they don't actually have to specify this and it's probably not an interesting parameter for most people. Suggest dropping from the example.
README.md
Outdated
| --config_file "C:\GreenPiThumb\greenpithumb\config.ini" \ | ||
| --sleep_window "23:15-07:00" \ | ||
| --sleep_window "14:30-15:45" \ | ||
| --image_path "C:\GreenPiThumb\greenpithumb\images" \ |
There was a problem hiding this comment.
They'll be running this from the Pi, so it'll be Linux-style paths. Suggest just putting "images/"
README.md
Outdated
| --sleep_window "23:15-07:00" \ | ||
| --sleep_window "14:30-15:45" \ | ||
| --image_path "C:\GreenPiThumb\greenpithumb\images" \ | ||
| --db_file "C:\GreenPiThumb\greenpithumb\greenpithumb.db" |
There was a problem hiding this comment.
Similar to the above, this is probably not interesting enough to give it visibility here. People should be okay with the default and if not they can run --help to figure out how to customize.
README.md
Outdated
|
|
||
| ## QuickStart Instructions | ||
|
|
||
| Run greenpithumb/greenpithumb.py and supply command-line flags for poll_interval, photo_interval, config_file, sleep_window, image_path, and db_file. Example below. |
There was a problem hiding this comment.
Suggest something like "After running the installation steps above on your Pi, run GreenPiThumb with a command like the following"
README.md
Outdated
| Run greenpithumb/greenpithumb.py and supply command-line flags for poll_interval, photo_interval, config_file, sleep_window, image_path, and db_file. Example below. | ||
|
|
||
| ```bash | ||
| python greenpithumb/greenpithumb.py \ |
There was a problem hiding this comment.
It needs to be sudo python because they need root privileges for the hardware stuff.
README.md
Outdated
| --photo_interval 240 \ | ||
| --sleep_window "23:15-07:00" \ | ||
| --sleep_window "14:30-15:45" \ | ||
| --image_path "images/" |
There was a problem hiding this comment.
Add moisture_threshold too? I guess it's going to vary per system.
No description provided.