diff --git a/.github/README.md b/.github/README.md index 516e68b..ed3e167 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,4 +1,4 @@ -# ncube - Generalized Hypercube Visualizer +# ncube - A Generalized Hypercube Visualizer `ncube` allows you to visualize hypercubes of arbitrary dimensions. It works by rotating the hyperdimensional vertices and applying a chain of perspective projections to them until the 3rd dimension is reached. @@ -15,15 +15,22 @@ Aditional features: ### Download the pre-built binaries Pre-built binaries for Windows, Linux, MacOS can be found in the [releases](https://github.com/ndavd/ncube/releases) page. +### Install from crates.io +Install [cargo](https://doc.rust-lang.org/stable/cargo/) and run the command: +``` +cargo install ncube +``` + ### Install from source -You need to setup Rust ([cargo](https://doc.rust-lang.org/stable/cargo/)) to build this project from source. +You need to setup Rust (install [cargo](https://doc.rust-lang.org/stable/cargo/)) to build this project from source. After that, simply clone clone the repository and run the install command: ``` git clone https://github.com/ndavd/ncube cd ncube cargo install --path . ``` -To uninstall, simply run: + +### Uninstall ``` cargo uninstall ncube ``` diff --git a/Cargo.toml b/Cargo.toml index 41c6ad2..c5831ab 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,6 +5,11 @@ edition = "2021" authors = ["Nuno David "] license = "MIT" description = "Generalized hypercube visualizer" +readme = ".github/README.md" +repository = "https://github.com/ndavd/ncube" +exclude = [".github/demo.gif"] +keywords = ["simulation", "hypercube", "bevy", "mathematics", "tesseract"] +categories = ["simulation", "mathematics", "visualization", "graphics"] [dependencies] bevy = "0.11.0"