README.md

hello-rust

Setup

Cargo

• Install the rust toolchain in order to have cargo installed by following this guide.
• Install hello-rust via

  # remote
  cargo install --git https://github.com/pythoninthegrass/hello-rust
  
  # local
  cargo install --path .

Development

Setup

• Follow the setup instructions above to set up your environment
• Install devbox

  curl -fsSL https://get.jetpack.io/devbox | bash

Usage

• Basic commands

  # install dependencies
  devbox install
  
  # enter devbox
  devbox shell
  
  # run app
  devbox run start
  
  # run tests
  devbox run test
  
  # create documentation
  devbox run build-docs
  
  # refresh devbox after making changes to devbox.json
  refresh
  
  # deactivate devbox
  exit

Further reading

Introduction | Rust GitHub Template

Rust By Example

Rust | Devbox

Conventional Commits