aboutsummaryrefslogtreecommitdiff
path: root/Readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'Readme.md')
-rw-r--r--Readme.md16
1 files changed, 7 insertions, 9 deletions
diff --git a/Readme.md b/Readme.md
index 7a4e56f..50ff55e 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,6 +1,4 @@
[![Build Status](https://travis-ci.org/kompetenzbolzen/TermGL.svg?branch=master)](https://travis-ci.org/kompetenzbolzen/TermGL)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/9b19f9f7a8d241368f6ee640d824b293)](https://www.codacy.com/app/kompetenzbolzen/TermGL?utm_source=github.com&utm_medium=referral&utm_content=kompetenzbolzen/TermGL&utm_campaign=Badge_Grade)
-[![CodeFactor](https://www.codefactor.io/repository/github/kompetenzbolzen/TermGL/badge/master)](https://www.codefactor.io/repository/github/kompetenzbolzen/TermGL/overview/master)
# TermGL
@@ -10,7 +8,7 @@ List of current features:
- Automatic terminal size detection, online resizing
- Framerate target
-- Simple drawing functions
+- Simple shape-drawing functions
- Object Handling:
- Movement
- Collision
@@ -19,22 +17,22 @@ List of current features:
For more information on how to use, consult the documentation (`make doc`) and look at the example programs in `example/`.
-## Compiling the library
+## Building from source
-TermGL should compile just fine with just the c++ standard librarys. The Makefile is set up for clang, but gcc should also work.
+TermGL should compile just fine with just `libstdc++`. The Makefile is set up for clang, but gcc should also work.
Required Packages:
clang
make
-`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.
+`make` builds the library to `build/lib` and copies all needed header files to `build/inc`
Run `make run` to build and run the example program specified by `$TESTSOURCE` in the Makefile. It is not compiled against the library, but just statically linked with the .o-files for easier debugging. The same example-programs can also be linked with the dynamic library by using the Makefile in `example/`.
To build the documentation, install `doxygen` and run `make doc`.
-## Compile your project
+## Installation
-Compile your program with linkerflags:
+The `makefile` provides a `install` target, which installs headers in `/usr/include/` and the binary in `/usr/lib`. `PREFIX` can be set to alter install location.
- -L/path/to/lib -ltermgl -lstdc++
+PKGBUILD scripts are provided in `packaging` for easy installation on Arch-based systems.