WIP docs: commenting in main.c and README updates

This commit is contained in:
2026-06-16 12:09:31 -04:00
parent baa5a6935f
commit 5fe4f6dd91
2 changed files with 40 additions and 3 deletions

27
README.md Normal file
View File

@@ -0,0 +1,27 @@
# WrldBox Engine
## 🧊Introduction
**WrldBox** is a work-in-progress sandbox simulator made by Team wholeworldcoding. It is currently in a pretty developed experimental stage.
It consists of several components:
- `src/main.c`, Main script. Takes all other src and actually renders the engine.
- `ray.c`, rendering the simulation with raylib. (in OLD)
- And a bunch of new files in `src/` that compose the working physics simulation.
- OLD contains the original logic this came from.
This project *is* the next major `wholeworldcoding` project.
## 🛠️ Build and Compile
Clone the repository. Once you have navigated to the folder, you can run:
- `make`
## 🏅Credits
This project was impossible without the support of all three `wholeworldcoding` members.