瀏覽代碼

Add build instructions with Box2D

DricomDragon 3 年之前
父節點
當前提交
cdbbf57d77
共有 1 個文件被更改,包括 18 次插入1 次删除
  1. 18 1
      README.md

+ 18 - 1
README.md

@@ -1,3 +1,20 @@
 # TinyShooter
 
-A colorful platform 2D shooter with physics !
+A colorful platform 2D shooter with physics !
+
+## Build
+
+You need `make`, `SDL1` and [Box2D](https://github.com/erincatto/box2d) to build this project.
+
+Example on Ubuntu :
+```sh
+$ sudo apt install make g++ libsdl-dev libsdl-image1.2-dev libsdl-gfx1.2-dev
+$ make
+```
+
+**Warning about Box2D** : you need at least version 2.4.1 in order to compile this project. If your package manager is out of date, please build Box2D and install it from source.
+
+To execute :
+```sh
+$ make exec
+```