Skip to content

Commit

Permalink
Chore: Prepare for crates.io
Browse files Browse the repository at this point in the history
  • Loading branch information
ndavd committed Sep 9, 2023
1 parent 53e9b1b commit 9fac50f
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 6 deletions.
13 changes: 10 additions & 3 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
```
5 changes: 2 additions & 3 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,9 @@ jobs:
run: |
sudo apt-get update; sudo apt-get install pkg-config libx11-dev libasound2-dev libudev-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev
- run: cargo login
- name: Publish to crates.io
run: cargo publish --token ${CRATES_TOKEN}
env:
CRATES_TOKEN: ${{ secrets.CRATES_TOKEN }}
run: cargo publish

# Linux
release-linux:
Expand Down
5 changes: 5 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ edition = "2021"
authors = ["Nuno David <email@ndavd.com>"]
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"
Expand Down

0 comments on commit 9fac50f

Please sign in to comment.