982 B
982 B
Getting Started
Setup guide for [Project Name]
Prerequisites
- [Language runtime / compiler]
- [Package manager]
- [Additional prerequisites]
Installation
# Clone the repository
git clone https://github.com/dcherrera/[ProjectName].git
cd [ProjectName]
# Install dependencies
[install command]
Running Experiments
# Run a specific experiment
[command to run experiment]
# View results
[command to view output]
Project Layout
| Folder | Purpose |
|---|---|
experiments/ |
Experiment code (numbered runs) |
results/ |
Experiment results documentation |
data/ |
Datasets (gitignored) |
literature/ |
Paper notes & prior art |
src/ |
Implementation code |
tests/ |
Test suite |
Next Steps
- Read goals.md to understand success criteria
- Check open_questions.md for current research questions
- Review Architecture for technical design