From a9915fcd53e4c967ba0d40bc9ca1f44429c3bc2a Mon Sep 17 00:00:00 2001 From: Sam Hocevar Date: Mon, 5 Sep 2016 19:23:26 +0200 Subject: [PATCH] doc: update README.md --- README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 419467a..00e877c 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,35 @@ -## roflmao +# roflmao `roflmao` is a simple project using Lol Engine. If you want to get -started with Lol Engine, you should fork this project. +started with Lol Engine, you may either: -# Setup + - fork this project + - duplicate this project (see [https://help.github.com/articles/duplicating-a-repository/](“duplicating a repository”)) + +## Setup Make sure Lol Engine and its submodules are properly initialised: git submodules update --init --recursive -# Configure +On Linux, make sure the following packages are installed: + + automake autoconf libtool pkg-config + libglew-dev + libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev + +## Configure The default application is called `roflmao` and lies in its own subdirectory. You should rename it to whatever your application will be called. Make sure to modify the following files: - - `configure.ac` - - `Makefile.am` - - `roflmao/Makefile.am` - - `roflmao/roflmao.cpp` + configure.ac + Makefile.am + roflmao/Makefile.am + roflmao/roflmao.cpp -# Build +## Build Then bootstrap the project and configure it: @@ -31,6 +40,3 @@ Finally, build the project: make -# Develop - -The sample application is in `roflmao`