boids-playground/README.md
2023-08-14 20:13:18 +00:00

51 lines
1.3 KiB
Markdown

# Boid playground
![Screenshot](https://git.rpuzonas.com/rpuzonas/boids-playground/raw/branch/main/screenshot.png)
A project for playing around with boid simulation paramaters live. This project ain't perfect, there are still
lots of TODO's. But I am content with leaving in this kind of state, it performs pretty well and can compile
to WASM.
WEB version: https://rpuzonas.com/boid-playground
Desktop version: https://git.rpuzonas.com/rpuzonas/boids-playground/releases
## Getting Started
### Installing Dependencies
Before building the project, you will need to install all relevant dependencies
for your platform so that the project has access to all the tools required, and
raylib can compile and link correctly. You can find intructions for
installing dependencies on macOS, Linux, and Windows in the [docs file on
installing dependencies](docs/InstallingDependencies.md).
### Building the Project
Once you have cloned this repository and installed dependencies, building the
project is as simple as running these two commands in its root directory:
#### macOS & Linux
Desktop:
```console
$ make setup
$ make
```
Web:
```console
$ make setup PLATFORM=web
$ make PLATFORM=web
```
#### Windows
Desktop:
```console
> mingw32-make setup
> mingw32-make
```
Web:
```console
> mingw32-make setup PLATFORM=web
> mingw32-make PLATFORM=web
```