2022-09-04 23:09:54 +02:00
|
|
|
# gz-cpp-util
|
2022-09-05 01:00:33 +02:00
|
|
|
cpp-20 utility library for my projects
|
2022-09-04 23:09:54 +02:00
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
- Extensive logger using variadic templates to log almost anything
|
2022-09-11 01:30:15 +02:00
|
|
|
- vecX and matMxN vector and matrix classes
|
2022-09-04 23:09:54 +02:00
|
|
|
- Some containers like a thread safe queue and a ringbuffer
|
|
|
|
|
- Regex that works with std::string_view
|
|
|
|
|
- Type conversion utility (from string to int/float/uint/bool)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
### Arch Linux (ABS)
|
|
|
|
|
- Download PKGBUILD: `wget https://raw.github.com/MatthiasQuintern/gz-cpp-util/main/PKGBUILD`
|
|
|
|
|
- Build and install with the Arch Build System: `makepkg -si`
|
|
|
|
|
|
|
|
|
|
### Linux
|
|
|
|
|
- Make a clone of this repo: `git clone https://github.com/MatthiasQuintern/gz-cpp-util`
|
|
|
|
|
- Build and install: `cd src && make && make install`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Usage
|
2022-09-05 03:10:27 +02:00
|
|
|
### Library
|
2022-09-04 23:09:54 +02:00
|
|
|
- Add `-lgzutil` to your linker flags
|
|
|
|
|
- Include the wanted header: `#include <gz-util/*dir*/*header.hpp*>`
|
2022-09-05 03:10:27 +02:00
|
|
|
|
|
|
|
|
### Enumeration-to-string script
|
|
|
|
|
- The gen_enum_str.py script will be installed to `/usr/bin/gz-enum-str`.
|
|
|
|
|
- Run `gz-enum-str -h` to list available options.
|
|
|
|
|
|
2022-09-04 23:09:54 +02:00
|
|
|
### Documentation
|
|
|
|
|
The documentation for this library can be generated using **doxygen**.
|
2022-09-05 01:00:33 +02:00
|
|
|
Install doxygen and run `make docs`, then open `docs/html/index.html`.
|
2022-09-04 23:09:54 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Changelog
|
2022-09-11 01:30:15 +02:00
|
|
|
### 2022-09-10
|
|
|
|
|
- Added matrices to math lib
|
|
|
|
|
- Improved logger
|
2022-09-04 23:09:54 +02:00
|
|
|
### 2022-09-05
|
|
|
|
|
- initial version
|
