WIP docs: commenting in codebase and README updates
This commit is contained in:
29
README.md
Normal file
29
README.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# WrldBox Sandbox Simulator
|
||||
|
||||
## 🧊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.
|
||||
- `src/physics.c`, All the science & math crap. Ugh. (physics.h: exposes UpdateEntities function)
|
||||
- `src/render.c`, Rendering of entities. Entities are currently limited to rectangles for... no particular reason. (render.h: exposes DrawEntities function)
|
||||
- `src/player.c`, Player control scripting. (player.h: exposes UpdatePlayerControls function)
|
||||
|
||||
|
||||
- More stuff in src. README in progress.
|
||||
|
||||
- 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.
|
||||
Reference in New Issue
Block a user