/template-rust

Rust Template for Bitwyre Projects

Primary LanguageShellGNU General Public License v3.0GPL-3.0

Repo/Module Name Here

This is the template for Rust Repository.

Copyright (C) 2021 Bitwyre Technologies Holdings Incorporated

Rust pre-requisites

Rust & Cargo

curl https://sh.rustup.rs -sSf | sh

or update if it's already installed:

rustup update

Rust components (formatting and code-styling)

rustup component add rls
rustup component add rustfmt
rustup component add clippy

Running with script

Apply recommended code formatting

./run.sh apply-style

Build binaries for debugging

./run.sh build

Build binaries for performance

./run.sh build-optimize

Code-style check and preliminary bug finding

./run.sh check-style

Development/Debugging run

./run.sh dev

Unit tests

./run.sh test

Performance run

./run.sh

Contributors

  • TBA
  • TBA