Merge pull request #5 from Glyphack/label

Author: Glyphack

.rules

@@ -1,58 +1,21 @@
-## Project Overview
-
-This project, named "simu," is a digital logic circuit simulator. It provides a graphical user interface (GUI) where users can build and simulate logic circuits. The application is built with Rust and uses the `egui` and `eframe` libraries for its GUI. It is designed to be cross-platform and can be compiled for both native and web environments.
-
-The simulator allows users to:
-
-*   Drag and drop logic gates (AND, NAND, OR, NOR, XOR, XNOR) and power sources onto a canvas.
-*   Connect these components using wires.
-*   Toggle power sources to observe the flow of electricity through the circuit.
-*   A debug panel is available to inspect the internal state of the simulation.
-
-
-Main code is in ./src/app.rs
-
-## Building and Running
-
-### Native
-
-To build and run the native application, use the following command:
-
-```bash
-cargo run
-```
-
-### Web
-
-The web application is built using [Trunk](https://trunkrs.dev/). To build and serve the web application locally, use the following command:
-
-```bash
-trunk serve
-```
-
-This will build the application and start a local server. You can then access the application in your web browser at the address provided by Trunk (usually `http://127.0.0.1:8080`).
-
-### Checking the Code
-
-The project includes a `check.sh` script that runs a series of checks to ensure code quality. To run these checks, execute the following command:
-
-```bash
-./check.sh
-```
-
-This script will:
-
-*   Check for compilation errors (`cargo check`).
-*   Check for formatting issues (`cargo fmt`).
-*   Lint the code with Clippy (`cargo clippy`).
-*   Run tests (`cargo test`).
-*   Build the web application (`trunk build`).
-
-## Development Conventions
-
-*   **GUI:** The application uses the `egui` and `eframe` libraries for its GUI. All UI components and interactions are implemented using these libraries.
-*   **State Management:** The application state is managed in the `App` struct in `src/app.rs`. This includes the state of all circuit components, user interactions, and the simulation itself.
-*   **Simulation:** The core simulation logic is implemented in the `recompute_current` and `eval_instance` methods in `src/app.rs`. The simulation is re-run whenever the circuit is modified.
-*   **Cross-Platform:** The application is designed to be cross-platform. The `src/main.rs` file contains separate entry points for the native and web builds.
-*  run `./check.sh` after your changes and ensure there are no warnings or errors.
-    ```
+# Simu - Digital Logic Circuit Simulator
+
+**Build Commands:**
+- Native: `cargo run`
+- Web: `trunk serve`
+- All checks: `./check.sh` (includes cargo check/fmt/clippy/test + trunk build)
+
+**Architecture:**
+- Rust 2024 edition with egui/eframe GUI framework
+- Cross-platform (native + WASM web builds)
+- Core modules: app.rs (main logic), connection_manager, custom_circuit, drag, save_load
+- Uses slotmap for entity management, serde for persistence
+
+**Code Style:**
+- Strict linting: unsafe_code=deny, extensive clippy rules enabled
+- No unsafe code, warn on trivial issues
+- Formatting: `cargo fmt --all -- --check`
+- Imports: std first, then external crates, then local modules
+- Naming: snake_case functions/variables, PascalCase types, SCREAMING_SNAKE_CASE constants
+- Error handling: Result/Option types preferred over panics
+- Run `./check.sh` after changes to ensure no warnings/errors

check.sh

@@ -1,12 +1,12 @@
 #!/usr/bin/env bash
 # This scripts runs various CI-like checks in a convenient way.
-set -eux
+set -eu
 
 cargo check --quiet --workspace --all-targets
 cargo check --quiet --workspace --all-features --lib --target wasm32-unknown-unknown
 cargo fmt --all -- --check
 cargo clippy --quiet --workspace --all-targets --all-features --  -D warnings -W clippy::all
-cargo test --quiet --workspace --all-targets --all-features
-cargo test --quiet --workspace --doc
+cargo test --quiet --workspace --all-targets --all-features > /dev/null
+cargo test --quiet --workspace --doc > /dev/null
 
-env -u NO_COLOR trunk build
+env -u NO_COLOR trunk build --quiet > /dev/null