瀏覽代碼

Update build instructions

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

+ 10 - 21
README.md

@@ -2,31 +2,20 @@
 
 A 2D driving game made with C++ and Box2D
 
-## To compile
+## Build
 
-### Ubuntu dependencies
+You need `make`, `SDL1` and [Box2D](https://github.com/erincatto/box2d) to build this project.
 
-```
-sudo apt install libsdl-image1.2-dev libsdl-gfx1.2-dev libbox2d-dev
+Example on Ubuntu :
+```sh
+$ sudo apt install make g++ libsdl-dev libsdl-image1.2-dev libsdl-gfx1.2-dev
+$ make
 ```
 
-### 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.
 
-In the root folder :
-```
-make
-```
-
-To execute the game :
-```
-./a.out
+To execute :
+```sh
+$ make exec
 ```
 
-## To run the game
-
-### Ubuntu
-
-```
-sudo apt install libsdl-image1.2 libsdl-gfx1.2 libbox2d2.3.0
-./a.out
-```