updated the help and README

This commit is contained in:
Yael-II
2024-11-28 23:04:49 +01:00
parent 25110aa2e7
commit 5054094ca5
2 changed files with 29 additions and 15 deletions

View File

@@ -44,22 +44,28 @@ First, select a configuration file (if none, default is selected).
Then, select the action you wish to perform. Then, select the action you wish to perform.
Available commands (not case sensitive): Available commands (not case sensitive):
- help, h, ?: show this page - `help`, `h`, `?`: show this page
- quit, exit, q: quit the current code - `quit`, `exit`, `q`: quit the current code
- cancel, back: cancels the current action (WARNING: this does not save the current state!)
- write, save: write the current table in a file - `write`, `save`: write the current table in a file
(no options available yet) (no options available yet)
- read, open [filename]: loads the file "filename" - `read [filename]`, `open [filename]`: loads the file "filename"
in the current table (no additional options available yet) in the current table (no additional options available yet)
- calibration, calib: adds a calibration in the target list - `calibration`, `calib`: adds a calibration in the target list
- simbad [object name], object [object name]: - `simbad [object name]`, `object [object name]`:
add an object from simbad add an object from simbad
- search [ra] [dec] [radius], region [ra] [dec] [radius]: - `search [ra] [dec] [radius]`, `region [ra] [dec] [radius]`:
search a region centred on the ra/dec coordinates, search a region centred on the ra/dec coordinates,
with a given radius (coordinates should be expressed as with a given radius (coordinates should be expressed as
12h30m30s, 90d30m30s or 90.555d) `12h30m30s`, `90d30m30s` or `90.555d`)
- sidereal, st: computes the sidereal time for each target - `sidereal`, `st`: computes the sidereal time for each target
- sequence, seq: computes the sequence order for each - `sequence`, `seq`: computes the sequence order for each
target target
- check: check if all targets are in the observation field - `check`: check if all targets are in the observation field
General actions:
- `cancel`, `back`: cancels the current action
- `yes`, `y`, `1`: yes
- `no`, `n`, `0`, or anything else: no
- `all`, `*`: select all
- `done`, `ok`: confirm, save the current state and quit

View File

@@ -707,11 +707,12 @@ def print_help():
"Help will be always given to those who ask for it [1].\n" "Help will be always given to those who ask for it [1].\n"
"Available commands (not case sensitive):\n" "Available commands (not case sensitive):\n"
"\t- help, h, ?: show this page\n" "\t- help, h, ?: show this page\n"
"\t- quit, exit, q: quit the current code\n" "\t- quit, exit, q: quit the current code "
"\t- cancel, back: cancels the current action\n" "(WARNING: this does not save the current state!)\n"
"\t- write, save: write the current table in a file " "\t- write, save: write the current table in a file "
"(no options available yet)\n" "(no options available yet)\n"
"\t- read, open [filename]: loads the file \"filename\" " "\t- read [filename], open [filename]: "
"loads the file \"filename\" "
"in the current table (no additional options available yet)\n" "in the current table (no additional options available yet)\n"
"\t- calibration, calib: adds a calibration in the target list\n" "\t- calibration, calib: adds a calibration in the target list\n"
"\t- simbad [object name], object [object name]: " "\t- simbad [object name], object [object name]: "
@@ -725,6 +726,13 @@ def print_help():
"target\n" "target\n"
"\t- check: check if all targets are in the observation field\n" "\t- check: check if all targets are in the observation field\n"
"\n" "\n"
"General actions: \n"
"\t- cancel, back: cancels the current action\n"
"\t- yes, y, 1: yes\n"
"\t- no, n, 0, or anything else: no\n"
"\t- all, *: select all\n"
"\t- done, ok: confirm, save the current state and quit"
"\n"
"[1] Pr. Dumbledore, Albus Percival Wulfric Brian, 1992, Hogwarts School of Witchcraft and Wizardry" "[1] Pr. Dumbledore, Albus Percival Wulfric Brian, 1992, Hogwarts School of Witchcraft and Wizardry"
"\033[0m") "\033[0m")
print(hilfe) print(hilfe)