Skip to content

QUICKSTART.md

Latest commit

 

History

History
25 lines (20 loc) · 606 Bytes

QUICKSTART.md

File metadata and controls

25 lines (20 loc) · 606 Bytes

LithicRivers Quick Start

Prerequisites

  • Rust (latest stable)
  • just command runner (cargo install just)

Getting Started

  1. Clone the repository
  2. Install dependencies: just install
  3. Run the game: just run

Common Commands

  • just build - Build the project
  • just test - Run tests
  • just check - Run clippy and checks
  • just format - Format the code

Development Workflow

  1. Create a feature branch
  2. Make your changes
  3. Run tests: just test
  4. Format code: just format
  5. Submit a pull request

For more details, see the documentation in the docs/ folder.