aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAleksa Vučković <56649122+aleksav013@users.noreply.github.com>2021-05-23 13:14:49 +0200
committerGitHub <noreply@github.com>2021-05-23 13:14:49 +0200
commiteddcc44d9a2fd225625c786a13e647d2a6d03643 (patch)
tree798b472b9ad4252754198424e56cf9bfbd3b6502 /README.md
parent4a5570448e7e2a5b80636a8c2b71212049fa2ba1 (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 20 insertions, 1 deletions
diff --git a/README.md b/README.md
index 94c3387..ddd8eca 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,21 @@
# sfml-rpg
-Simple SFML school project
+Simple C++ SFML school project.
+## Compiling
+### Linux
+- Install sfml package from your package manager:
+ - [**libsfml-dev**](https://packages.debian.org/buster/libsfml-dev) for Debian based distributions
+ - [**sfml**](https://archlinux.org/packages/community/x86_64/sfml/) for Arch based distributions
+```
+g++ -std=c++14 -O2 -o sfml-rpg main.cpp -lsmfl-graphics -lsfml-window -lsfml-system
+```
+
+### Windows
+- Download [latest stable version](https://www.sfml-dev.org/download.php) of SFML
+- Install [mingw-w64](http://mingw-w64.org/doku.php/download/mingw-builds)
+- Add mingw64\bin to $PATH
+```
+g++ -std=c++14 -O2 -o sfml-rpg main.cpp -I SFML-2.5.1\include -L SFML-2.5.1\lib -lsfml-graphics -lsfml-window -lsfml-system
+```
+> If you use Visual Studio or Code::Blocks you can follow [official tutorial](https://www.sfml-dev.org/tutorials) for setting up SFML.
+## Requirements
+- SFML 2.5+ version