mw-cli/README.md

49 lines
1.5 KiB
Markdown

# mw-cli
FIXME: description
## Installation
Download from http://example.com/FIXME.
## Usage
$ java -jar mw-cli-0.1.0-standalone.jar [options]
where options include:
* -d, --display FILE Display generated world as HTML file
* -g, --generations true The number of generations to run.
* -h, --help Show this message
* -m, --heightmap FILE The path to the raster (gif, jpeg or png) file containing the heightmap to load.
* -o, --output FILE The path to the EDN file to which to output the result.
* -r, --rules true The path to the text file containing the rules to run.
* -v, --verbosity [LEVEL] The amount of logging information to output; an integer between 1 and 4.
## Examples
...
### Bugs
...
### Any Other Sections
### That You Think
### Might be Useful
## License
Copyright © 2020 FIXME
This program and the accompanying materials are made available under the
terms of the Eclipse Public License 2.0 which is available at
http://www.eclipse.org/legal/epl-2.0.
This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the Eclipse
Public License, v. 2.0 are satisfied: GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or (at your
option) any later version, with the GNU Classpath Exception which is available
at https://www.gnu.org/software/classpath/license.html.