Merged README
This commit is contained in:
matthias@arch 2022-09-28 15:36:07 +02:00
commit ed39f1262c

View File

@ -1,8 +1,11 @@
# gz-util - About # gz-util - About
This c++20 library contains multiple useful functions, most of them are focused on working with strings. This c++20 library contains multiple useful functions, most of them are focused on working with strings.
Documentation is [available here](https://docs.quintern.xyz/gz-cpp-util/index.html).
Please report bugs on the [github page](https://github.com/MatthiasQuintern/gz-cpp-util)! Please report bugs on the [github page](https://github.com/MatthiasQuintern/gz-cpp-util)!
## Features ## Features
- Extensive logger using variadic templates to log almost anything - Extensive logger using variadic templates to log almost anything
- Some containers like a thread safe queue and a ringbuffer - Some containers like a thread safe queue and a ringbuffer
@ -26,7 +29,7 @@ I do not delevop on windows, but you'll figure it out.
The library does not contain platform specific code and should compile with mvsc. The library does not contain platform specific code and should compile with mvsc.
### Documentation ### Documentation
The documentation for this library can be generated using **doxygen**. The documentation is for this library is [available here](https://docs.quintern.xyz/), but it can also be generated using **doxygen**.
cd gz-cpp-util/src cd gz-cpp-util/src
make docs make docs
firefox ../docs/html/index.html firefox ../docs/html/index.html