duuqnd/cave-story-solaris
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add some readme stuff from the master branch

Browse source
This commit is contained in:
Clownacy 2019-09-04 01:55:38 +01:00
parent 79759145c0
commit 0efb219d94
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -6,10 +6,19 @@ This branch migrates the engine from WinAPI to SDL2, and addresses numerous port
![Screenshot](screenshot.png) ![Screenshot](screenshot.png)
## Dependencies
* SDL2
* FLTK
* GLEW (if the OpenGL rendering backend is selected)
## Building ## Building
### Makefile ### Makefile
*Note: this requires pkg-config*
Run 'make' in this folder, preferably with some of the following settings: Run 'make' in this folder, preferably with some of the following settings:
* `RELEASE=1` - Compile a release build (optimised, stripped, etc.) * `RELEASE=1` - Compile a release build (optimised, stripped, etc.)
@ -17,6 +26,10 @@ Run 'make' in this folder, preferably with some of the following settings:
* `JAPANESE=1` - Enable the Japanese-language build (instead of the unofficial Aeon Genesis English translation) * `JAPANESE=1` - Enable the Japanese-language build (instead of the unofficial Aeon Genesis English translation)
* `FIX_BUGS=1` - Fix bugs in the game (see [src/Bug Fixes.txt](src/Bug%20Fixes.txt)) * `FIX_BUGS=1` - Fix bugs in the game (see [src/Bug Fixes.txt](src/Bug%20Fixes.txt))
* `DEBUG_SAVE=1` - Re-enable the ability to drag-and-drop save files onto the window * `DEBUG_SAVE=1` - Re-enable the ability to drag-and-drop save files onto the window
* `RENDERER=OpenGL3` - Use the hardware-accelerated OpenGL 3.2 renderer
* `RENDERER=Texture` - Use the hardware-accelerated SDL2 Texture API renderer (default)
* `RENDERER=Surface` - Use the software-rendered SDL2 Surface API renderer
* `RENDERER=Software` - Use a hand-written software renderer
## Licensing ## Licensing