diff --git a/.github/README.md b/.github/README.md index fa453ea..6de9800 100644 --- a/.github/README.md +++ b/.github/README.md @@ -9,12 +9,15 @@ It also allows for controlling the simulation in real time, such as tweaking the ## Installation -### Building from source +### 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. + +### Build from source You need to setup Rust ([cargo](https://doc.rust-lang.org/stable/cargo/)) to build this project from source. -After that, simply clone the project and run the build command: +After that, simply clone the project and run the project: ``` git clone https://github.com/ndavd/ncube cd ncube -cargo build --release -./target/release/ncube +cargo run --release ``` +Keep in mind that if you want to move the binary you must also take the `assets/` folder with it and keep them in the same directory. diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 34b5485..9e7c3e8 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -34,32 +34,6 @@ jobs: - name: Run cargo test run: cargo test - # Run cargo clippy -- -D warnings - clippy_check: - name: Clippy - runs-on: ubuntu-latest - steps: - - name: Checkout sources - uses: actions/checkout@v3 - - name: Cache - uses: actions/cache@v3 - with: - path: | - ~/.cargo/bin/ - ~/.cargo/registry/index/ - ~/.cargo/registry/cache/ - ~/.cargo/git/db/ - target/ - key: ${{ runner.os }}-cargo-clippy-${{ hashFiles('**/Cargo.toml') }} - - name: Install stable toolchain - uses: dtolnay/rust-toolchain@stable - with: - components: clippy - - name: Install Dependencies - run: sudo apt-get update; sudo apt-get install pkg-config libx11-dev libasound2-dev libudev-dev - - name: Run clippy - run: cargo clippy -- -D warnings - # Run cargo fmt --all -- --check format: name: Format