Browse Source

doc: update README.md

master
Sam Hocevar 8 years ago
parent
commit
a9915fcd53
1 changed files with 18 additions and 12 deletions
  1. +18
    -12
      README.md

+ 18
- 12
README.md View File

@@ -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`

Loading…
Cancel
Save