diff options
| -rw-r--r-- | Readme.md | 12 |
1 files changed, 9 insertions, 3 deletions
@@ -1,7 +1,11 @@ [](https://travis-ci.org/kompetenzbolzen/engine) [](https://www.codacy.com/app/kompetenzbolzen/engine?utm_source=github.com&utm_medium=referral&utm_content=kompetenzbolzen/engine&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: |