diff --git a/Cargo.toml b/Cargo.toml index fe2450a..2304203 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,15 +1,16 @@ [package] -name = "pixel_fight_rs" +name = "pixel_fight" version = "0.1.0" edition = "2021" - -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +description = "A very simple zero-player fight simulator between groups of squares." +authors = ["Matthieu JOLIMAITRE "] +license = "MIT" [dependencies] anyhow = "1.0.50" -clap = { version = "3.2.20", features = ["derive"] } -rand = "0.8.5" -rayon = "1.5.3" -ron = "0.8.0" -serde = { version = "1.0.144", features = ["derive"] } -speedy2d = "1.8.0" +clap = { version = "3.2", features = ["derive"] } +rand = "0.8" +rayon = "1.5" +ron = "0.8" +serde = { version = "1.0", features = ["derive"] } +speedy2d = "1.8" diff --git a/README.md b/README.md new file mode 100644 index 0000000..bd52473 --- /dev/null +++ b/README.md @@ -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 + + 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 +``` \ No newline at end of file diff --git a/assets/capture.png b/assets/capture.png new file mode 100644 index 0000000..2b7e812 Binary files /dev/null and b/assets/capture.png differ