licensing, initial documentation initiative

This commit is contained in:
Blue 2023-03-23 20:27:46 +03:00
parent f5612dc3c5
commit 763d956bf8
Signed by: blue
GPG key ID: 9B203B252A63EE38
30 changed files with 1178 additions and 383 deletions

View file

@ -6,9 +6,10 @@
### Prerequisites
- QT 5 *(lower versions might work but it wasn't tested)*
- Qt 5 or higher
- lmdb
- CMake 3.16 or higher
- Doxygen (optional, for documentation)
### Using with CMake
@ -60,6 +61,7 @@ Here is the list of keys you can pass to configuration phase of `cmake ..`:
- `CMAKE_BUILD_TYPE` - `Debug` just builds showing all warnings, `Release` builds with no warnings and applies optimizations (default is `Debug`);
- `BUILD_STATIC` - `True` builds project as a static library, `False` builds as dynamic (default is `False`);
- `BUILD_TESTS` - `True` build unit tests, `False` does not (default is `False`);
- `BUILD_DOC` - `True` build doxygen documentation, `False` does not (default is `False`);
- `QT_VERSION_MAJOR` - `5` links against Qt5, `6` links agains Qt6, there is no default, so, if you didn't specify it the project will chose automatically;
#### Running tests