Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
piotrek-szczygiel authored Jun 21, 2021
1 parent a81a719 commit daafde6
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,42 @@
# sim
<h1 align="center">Predator-Prey simulator</h1>

![cmake](https://github.com/piotrek-szczygiel/sim/actions/workflows/cmake.yml/badge.svg)
<p align="center">
<img height=70 src="assets/icon.svg" alt="Icon">
</p>

<p align="center">
Predator-Prey simulator written in C++.
</p>

Predator-Prey simulation
# Building ![cmake](https://github.com/piotrek-szczygiel/sim/actions/workflows/cmake.yml/badge.svg)

## Requirements
Required programs:

- C++ compiler
- cmake

### Submodules
## Downloading submodules

```bash
git submodule update --init --recursive
```

### Ubuntu
## Installing Ubuntu dependencies

```bash
sudo apt install \
build-essential git cmake libasound2-dev mesa-common-dev libx11-dev \
libxrandr-dev libxi-dev xorg-dev libgl1-mesa-dev libglu1-mesa-dev libluajit-5.1-dev
```

## Building
## Running CMake
```bash
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build .
```

## Running
# Running Predator-Prey simulator
```bash
./sim # Launch graphical interface

Expand All @@ -40,3 +45,9 @@ cmake --build .
# Helper script to create 10 plots of 1000 tick simulations and launch them as 4 parallel processes
python run_and_plot.py sim.exe 1000 default.lua 10 4
```

# Attributions

Textures by [Franuka](https://franuka.itch.io/).

Icon made by [Freepik](https://www.freepik.com/) from [Flaticon](https://www.flaticon.com/).

0 comments on commit daafde6

Please sign in to comment.