Browse Source

Add Readme

Pabloader 5 years ago
parent
commit
a35ee0e36d
2 changed files with 24 additions and 2 deletions
  1. 0
    2
      Makefile
  2. 24
    0
      README.md

+ 0
- 2
Makefile View File

@@ -1,5 +1,3 @@
1
-# To compile this you will need MinGW with MSYS installed in PATH
2
-
3 1
 CPPFLAGS=-Wall -Wno-misleading-indentation -Werror --std=c++1z
4 2
 LDFLAGS=
5 3
 INCLUDES=-Iinclude -Ipge/include

+ 24
- 0
README.md View File

@@ -0,0 +1,24 @@
1
+# About
2
+
3
+This game is written for [OLC Code Jam 2019](https://itch.io/jam/olc-codejam-2019) using modified [OLC Pixel Game Engine](https://github.com/OneLoneCoder/olcPixelGameEngine)
4
+
5
+# How to compile on Windows
6
+
7
+To compile on windows you need MinGW-32 and MSYS (or Cygwin or Git-Bash) installed in PATH
8
+
9
+## Download links: 
10
+- [MinGW](http://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win32/Personal%20Builds/mingw-builds/installer/mingw-w64-install.exe/download)
11
+- [MSYS](https://osdn.net/projects/mingw/downloads/68260/mingw-get-setup.exe/)
12
+
13
+**WARNING!** _MinGW version from second link is too old, do not install MinGW from mingw-get, install only MSYS_
14
+
15
+# How to compile on linux
16
+
17
+For Debian/Ubuntu: 
18
+
19
+    sudo apt install libx11-dev libgl-dev libpng-dev libasound2-dev
20
+
21
+
22
+# Make it!
23
+
24
+Just run `make` command to build

Loading…
Cancel
Save