WIP docs: commenting in main.c and README updates
This commit is contained in:
@@ -1,25 +0,0 @@
|
||||
# WrldBox Sandbox Simulator
|
||||
|
||||
## 🧊Introduction
|
||||
|
||||
**WrldBox** is a work-in-progress sandbox simulator made by Team wholeworldcoding. It is currently in an experimental stage.
|
||||
|
||||
It consists of two components:
|
||||
|
||||
- `text_physics.c`, a text-based 1-object physics simulation
|
||||
|
||||
- `ray.c`, rendering the simulation with raylib.
|
||||
|
||||
This project has a huge potential to become the next major `wholeworldcoding` project.
|
||||
|
||||
## 🛠️ Build and Compile
|
||||
|
||||
Clone the repository. Once you have navigated to the folder, you can run:
|
||||
|
||||
- `make text && ./text_physics.out` to compile and run `text_physics.c`
|
||||
|
||||
- `make visual && ./ray.out` to compile and run `ray.c`
|
||||
|
||||
## 🏅Credits
|
||||
|
||||
This project was impossible without the support of all three `wholeworldcoding` members.
|
||||
@@ -1,4 +1,7 @@
|
||||
<<<<<<< HEAD
|
||||
# WrldBox Engine
|
||||
=======
|
||||
# WrldBox Sandbox Simulator
|
||||
|
||||
## 🧊Introduction
|
||||
|
||||
@@ -8,9 +11,7 @@ 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.
|
||||
- More stuff in src. README in progress.
|
||||
|
||||
- OLD contains the original logic this came from.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user