README.md

seawater

A high performance entity component system useful as a backend for developing GUI applications and video games.

Table of contents

• Prerequisites
• Format the project
• Automatically format the project on change
• Lint the project
• Automatically lint the project on change
• Build the project
• Automatically build the project on change
• Test the project
• Automatically test the project on change

Prerequisites

• Windows 11 or Linux
• Visual Studio Code with plugins:
  • Better TOML
  • CodeLLDB
  • EditorConfig for VS Code
  • Markdown All in One
  • rust-analyzer
  • YAML
• Rust 1.60.0 and later
• rustfmt 1.4.38 and later
• clippy 0.1.60 and later
• cargo-watch 8.1.1 and later

Format the project

cargo fmt

Automatically format the project on change

cargo watch -x fmt

Lint the project

cargo clippy --all-features

Automatically lint the project on change

cargo watch -x "clippy --all-features"

Build the project

cargo build

Automatically build the project on change

cargo watch -x build

Test the project

cargo test

Automatically test the project on change

cargo watch -x test