From 11cfd7c9602c3b10c72796c6277a74a09e9079fd Mon Sep 17 00:00:00 2001 From: Lionel Date: Thu, 20 Dec 2018 13:58:55 +0100 Subject: Updated README.md --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e4894da..2867887 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,39 @@ Hi everyone ! Neato Control is a GUI based interface for [pybotvac](https://github.com/stianaske/pybotvac) - +# INSTALLATION ```python pip install neatocontrols ``` +# USAGE + +For the `aneatocli.py` script : + +```bash +Usage: + aneatocli.py (--gc | --get-commands) + aneatocli.py (--go | --start-cleaning ) + aneatocli.py (--stp | --stop-cleaning ) + aneatocli.py (--pse | --pause-cleaning ) + aneatocli.py (--res | --resume-cleaning) + aneatocli.py (--base | --send-to-base ) + aneatocli.py (--gi |--get-infos ) + aneatocli.py (--lgsc | --log-secrets) + aneatocli.py (--ltst | --log-tests) + aneatocli.py -h | --help + aneatocli.py -v | --version + +Options: + -h , --help Show this message. + -v , --version Show version. + --go , --start-cleaning Tell the robot to start cleaning. + --stp , --stop-cleaning Tell the robot to stop cleaning. + --pse , --pause-cleaning Tell the robot to pause cleaning. + --res , --resume-cleaning Tell the robot to resume cleaning. + --base ,--send-to-base Tell the robot to go back to its dock. + --gc , --get-commands Get the available commands and write them to file '-robotcommands.json' + --gi, --get-infos Get various infos about the current robot and write them to file '-robotinfos.json' + --lgsc , --log-secrets Log the credentials into the file '.json'. +``` + +Screenshots to come for the GUI part. -- cgit v1.2.3-54-g00ecf