added readme & cargo metadata

This commit is contained in:
JOLIMAITRE Matthieu 2022-09-04 01:33:03 +02:00
parent 9c96c9f828
commit fc03395c3f
3 changed files with 38 additions and 9 deletions

28
README.md Normal file
View file

@ -0,0 +1,28 @@
# Pixel Fight /rs
![capture](./assets/capture.png)
## Description
A very simple zero-player fight simulator between groups of squares.
## Usage
```sh
USAGE:
pixel_fight <SUBCOMMAND>
OPTIONS:
-h, --help Print help information
SUBCOMMANDS:
example Dumps an example fight configuration to stdout
run Runs a fight from a configuration file
```
## Installation
can be installed with rustup/cargo:
```sh
cargo install pixel_fight
```