diff options
| author |  Jonas Gunz <himself@jonasgunz.de>
| 2020-02-10 16:16:05 +0100 |
|---|---|---|
| committer | Jonas Gunz <himself@jonasgunz.de>
| 2020-02-10 16:16:05 +0100 |
| commit | e89fb2c8bb21919cfd1f6622ade988768a57d5d1 (patch) | |
| tree | 09b3bbece068ed5c72e2ad0bb7e9c5d55cf66b6e | |
| parent | f2a0b74624ac69246034c3fdbab1ce26f8cb543e (diff) | |
| download | termgl-e89fb2c8bb21919cfd1f6622ade988768a57d5d1.tar.gz | |
Update readme
| -rw-r--r-- | Readme.md | 16 |
1 files changed, 7 insertions, 9 deletions
@@ -1,6 +1,4 @@ [](https://travis-ci.org/kompetenzbolzen/TermGL) -[](https://www.codacy.com/app/kompetenzbolzen/TermGL?utm_source=github.com&utm_medium=referral&utm_content=kompetenzbolzen/TermGL&utm_campaign=Badge_Grade) -[](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. |