From daafde6baa572e35f74a14046ba5657097e27167 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Szczygie=C5=82?= Date: Mon, 21 Jun 2021 18:09:37 +0200 Subject: [PATCH] Update README.md --- README.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 719c24a..c2c0d85 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,27 @@ -# sim +

Predator-Prey simulator

-![cmake](https://github.com/piotrek-szczygiel/sim/actions/workflows/cmake.yml/badge.svg) +

+ Icon +

+

+ Predator-Prey simulator written in C++. +

-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 \ @@ -24,14 +29,14 @@ sudo apt install \ 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 @@ -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/).