Merge branch 'dev' into feat/wandb-logging

README.md

@@ -1,12 +1,10 @@
 # Brittle Star
 
-Reinforcement learning research on brittle star locomotion using PPO.
-
 ## Quick Start
 
 ### Installation
 
-Set up the environment using UV:
+To set up the UV module, you can run the following command:
 
 ```bash
 uv sync --frozen
@@ -33,7 +31,7 @@ uv sync --frozen
 
 ### Training
 
-Run training with your configuration:
+example command:
 
 ```bash
 uv run python src/train.py
@@ -60,22 +58,6 @@ The training script uses a unified logging framework that:
 
 All experiment data is preserved locally, even if WandB is unavailable.
 
-## Project Structure
+## HPC
 
-```
-src/brittle_star_project/  # Core library (reusable components)
-├── logging/               # Unified logging framework
-├── environment/           # Environment wrappers
-├── rl/                    # RL algorithms and models
-└── dataclasses/          # Configuration dataclasses
-
-configs/                   # Training configurations
-runs/                      # Training outputs (checkpoints, metrics)
-```
-
-## For Researchers
-
-**Important:** Do not commit your personal WandB credentials to the repository. 
-Instead, create your own config file (e.g., `configs/yourname.yaml`) and add it to `.gitignore` if needed.
-
-See [configs/README.md](configs/README.md) for more details on configuration management.
+See **[docs/HPC.md](docs/HPC.md)** for the full guide, including environment setup, cluster selection, interactive debugging, and job submission.