tastytea/xdgcfg
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Added CMake options to the readme.

Browse Source
This commit is contained in:
tastytea 2019-07-22 02:43:19 +02:00
parent e07a6ab6cb
commit 4b3ececa13
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -2,15 +2,15 @@
and writes files in `${XDG_CONFIG_HOME}`. It creates subdirectories if and writes files in `${XDG_CONFIG_HOME}`. It creates subdirectories if
necessary. necessary.
### Dependencies ## Dependencies
* C++ compiler (Tested: g++ 5/8) * C++ compiler (Tested: g++ 5/8)
* [cmake](https://cmake.org/) * [cmake](https://cmake.org/) (at least: 3.1)
* [pkgconfig](https://pkgconfig.freedesktop.org/wiki/) * [pkgconfig](https://pkgconfig.freedesktop.org/wiki/)
* [libconfig++](https://github.com/hyperrealm/libconfig) * [libconfig++](https://github.com/hyperrealm/libconfig)
* [libxdg-basedir](http://repo.or.cz/w/libxdg-basedir.git) * [libxdg-basedir](http://repo.or.cz/w/libxdg-basedir.git)
### Usage ## Install
Copy `xdgcfg.hpp` into a folder where your project can find it. Copy `xdgcfg.hpp` into a folder where your project can find it.
@ -22,8 +22,13 @@ make
make install make install
``` ```
### CMake options
### Documentation * `-DWITH_TESTS=YES` to compile the tests.
* `-DWITH_EXAMPLES=YES` to compile the example.
## Documentation
`xdgcfg.hpp` has explanatory comments in it and there is an `xdgcfg.hpp` has explanatory comments in it and there is an
[example](src/example.cpp). The reference is also available at [example](src/example.cpp). The reference is also available at