diff options
Diffstat (limited to 'README.txt')
| -rw-r--r-- | README.txt | 55 |
1 files changed, 54 insertions, 1 deletions
@@ -1 +1,54 @@ -zp +- zP - + + | \ + | \ + | | + | / +<---+--/ + \ | + > | + / | +<---+ + +# ABOUT + +zp is a library for low-level (and high-level) +algorithms and the querying of system details. + The algorithms are - by default - implemented +in C++, but for some targets they may be +implemented in a platform-dependent manner +(such as in an assembly language) for the sake +of performance. Despite this, the language is +still quite early in its development, and these +algorithms may still not be the most efficient. + +# CHANGELOG + +Read: "CHANGELOG.txt" + +# COMPILATION + +Provided are CMake lists files, which + The provided script "getTarget.sh" detects the +target (if supported - otherwise defaults to +"Any") to be passed to CMake. + +## INSTALLATION + +The provided script "install.sh" installs the +library and the (public) headers to the +specified directories: + +./install.sh [build directory] [library directory] [include directory] + +The script automatically builds the project +using pre-defined settings. Note that it does +recursively remove the build directory before +initialising it. + +# COPYRIGHT AND LICENSE + +Copyright 2022-2023 Gabriel Jensen. +The source files of this project are - where +noted - licensed under the second version of +the Mozilla Public License. |