summaryrefslogtreecommitdiff
path: root/Readme.md
diff options
context:
space:
mode:
authorGravatar Jonas Gunz <himself@jonasgunz.de> 2019-03-05 17:59:22 +0100
committerGravatar Jonas Gunz <himself@jonasgunz.de> 2019-03-05 17:59:22 +0100
commitda1a27f74e13d6ab94696fd8dc5d20526c6973c6 (patch)
treeb144415bacc7d594540b7116719254ce05d29aef /Readme.md
parent209bc3d1f9c330a32981c55a6f90bf230b9e67fd (diff)
downloadtermgl-da1a27f74e13d6ab94696fd8dc5d20526c6973c6.tar.gz
Readme update
Diffstat (limited to 'Readme.md')
-rw-r--r--Readme.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/Readme.md b/Readme.md
index fa9be1a..8c9fe61 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,7 +1,11 @@
[![Build Status](https://travis-ci.org/kompetenzbolzen/engine.svg?branch=master)](https://travis-ci.org/kompetenzbolzen/engine)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/9b19f9f7a8d241368f6ee640d824b293)](https://www.codacy.com/app/kompetenzbolzen/engine?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=kompetenzbolzen/engine&amp;utm_campaign=Badge_Grade)
-## Compiling
+# engine (the most creative name I could come up with)
+
+engine is a library for displaying ASCII-graphics in a text console. For more information on how to use, consult the documentation (`make doc`) and look at the example program in `test.cpp`.
+
+## Compiling the library
engine should compile just fine with just the c++ standard librarys.
Required Packages:
@@ -9,9 +13,11 @@ Required Packages:
g++
make
-this creates two folders in ./build/: lib and inc, wich hold the library and the headers respectively. these can then be copied into your projects directory.
+`make` creates two folders in ./build/: lib and inc, wich hold the library and the headers respectively. these can then be copied into your projects directory. Run `make run` to build and run the example program.
+
+To build the documentation, install `doxygen` and run `make doc`.
-## Using
+## Compile your project
Compile your program with linkerflags: