Update running the code section in README

The previous version asked users to run `polaris -h` which
is an invalid flag. Updated the flag to `polaris --help`.

Also updated the output (copied from the terminal directly)
Signed-off-by: Adithya Venkateswaran's avatarAdithya Venkateswaran <[email protected]>
parent 473ba6d8
......@@ -49,16 +49,20 @@ $ (.venv) pip install polaris-ml
## Running the code
```bash
$ (.venv) polaris -h
Tool for analyzing satellite telemetry
$ (.venv) polaris --help
Usage: polaris [OPTIONS] COMMAND [ARGS]...
Tool for analyzing satellite telemetry
Options:
--help Show this message and exit.
--version Show the version and exit.
--help Show this message and exit.
Commands:
fetch Download data set(s)
learn Analyze data
viz Displaying results
fetch Download data set(s)
learn Analyze data
viz Display results
# To fetch and decode data from the SatNOGS network, run:
$ (.venv) polaris fetch -s 2019-08-10 -e 2019-10-5 LightSail-2 /tmp/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment