From da1a27f74e13d6ab94696fd8dc5d20526c6973c6 Mon Sep 17 00:00:00 2001 From: Jonas Gunz Date: Tue, 5 Mar 2019 17:59:22 +0100 Subject: Readme update --- Readme.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'Readme.md') 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&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: -- cgit v1.2.3