Add usage statement in README.md

This commit is contained in:
Jip J. Dekker 2016-12-05 16:37:39 +01:00
parent ac7b103305
commit 873ea2cb00

View File

@ -1,6 +1,16 @@
# ChronoZinc
Small wrapper for `mzn-fzn` to benchmark MiniZinc models
# TODO
## Usage
```
chronozinc [config]* [models]* [data]*
```
Files are matched on extension:
- Models: `.mzn`
- Data: `.dzn`
- Configuration: `.json`, `.toml`, `.yml` (viper extensions)
## TODO
- Remove all usage of `viper` from parsing and runtime packages
- Provide separate the `run` and `parse` commands
- MORE DOCUMENTATION!!!