Verified Commit 8f4fc34e authored by Ole Martin Ruud's avatar Ole Martin Ruud
Browse files

Add help message to README

parent 1f7b712a
......@@ -4,6 +4,31 @@
A CLI application to order rooms through [tp.uio.no](https://tp.uio.no).
## Help
```
USAGE:
grupperom [FLAGS] [OPTIONS] <SUBCOMMAND>
FLAGS:
-h, --help Prints help information
-p Should prompt for FEIDE password (overrides `grupperom.yml`)
-V, --version Prints version information
-v Verbosity level (can be applied multiple times)
OPTIONS:
-b, --base-url <base-url> Base URL for the room ordering service (overrides `grupperom.yml`) [default:
https://tp.uio.no/ntnu/rombestilling/]
-l, --log-file <log-file> File where all actions will be logged based on verbosity level
-u <username> FEIDE username (overrides `grupperom.yml`)
SUBCOMMANDS:
help Prints this message or the help of the given subcommand(s)
options Display options regarding buildings, rooms, etc.
order Order the specified room the given day
query Query the service for avaliable rooms
```
## Configuration
Configuration variables have be specified in `grupperom.yml` in the config directory of the application. The application uses to the default directories for different platforms:
......
Supports Markdown
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