Browse Source

clean up README.md manually

main
cinnaboot 6 months ago
parent
commit
4a557244c4
  1. 16
      README.md

16
README.md

@ -1,14 +1,11 @@
# Orbital Mechanics Simulation
A 3D orbital mechanics simulation using a 2-body gravitational model with sphere of influence (SOI) transitions. Built with C-style C++ and raylib.
A 3D orbital mechanics simulation using a 2-body gravitational model with sphere of influence (SOI) transitions.
## Features
- 2-body gravitational physics with SOI transitions
- Eccentric orbit support (circular and elliptical)
- 3D real-time visualization with interactive camera
- Configurable star systems via text files
- Simulation controls (pause, speed adjustment)
- Configurable star systems via toml files
- Solar system and binary star example configurations
## Getting Started
@ -44,19 +41,10 @@ make clean-all # Clean everything including raylib
./orbit_sim configs/example_binary_star.toml # Run with a custom configuration file:
```
## Controls
- **Arrow Keys**: Rotate and zoom camera
- **Space**: Pause/Resume simulation
- **+/-**: Speed up/slow down simulation
- **I**: Toggle info display
- **ESC**: Quit
## Documentation
- **[Technical Reference](docs/implementation_plan.md)** - Data structures and module overview
- **[Detailed Architecture](docs/verbose_project_overview.md)** - Complete implementation details and data flow
- **[Known Issues](docs/config_assumptions.md)** - Configuration bugs and future improvements
## Testing

Loading…
Cancel
Save