Skip to content

Commit

Permalink
docs: update readme config documentation as well as update example co…
Browse files Browse the repository at this point in the history
…nfig
  • Loading branch information
Slug-Boi committed Aug 9, 2024
1 parent 1ab4f23 commit feb20ae
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,13 @@ $ aion-cli solve gurobi [form_ID]
If the form_ID is saved to the config file using the optional --save flag then you can omit the form_ID argument for all future calls to the same form

### Config
The config command allows the user to edit or remove the config file the program uses. These are the subcommands:
The config command allows the user to edit or remove the config file the program uses. It has a TUI that can be accessed by running the base config command which allows for easy editing of the config file.
```
$ aion-cli config
```

You can also use subcommands instead.
These are the subcommands:
- solver - select the default solver the program uses
- formID - edit the default formID used when no argument is provided to certain commands
- ical - edit whether the program auto saves the solution as an ICal ics file when using the generate command
Expand Down
4 changes: 3 additions & 1 deletion examples/example_config.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
{
"version": "0.1",
"default_solver": "min_cost",
"formID": "",
"ical_save": false,
"csv_save": false
"csv_save": false,
"default_sorter": "timeslot"
}

0 comments on commit feb20ae

Please sign in to comment.