This repository has been archived on 2020-05-16. You can view files and clone it, but cannot push or open issues or pull requests.
xdgcfg/README.md
2018-08-10 02:33:31 +02:00

31 lines
691 B
Markdown

**xdgcfg** is a very simple wrapper around libconfig written in C++. It reads
and writes files into `${XDG_CONFIG_HOME}`. It creates subdirectories if
necessary.
### Dependencies
* C++ compiler
* [cmake](https://cmake.org/)
* [pkgconfig](https://pkgconfig.freedesktop.org/wiki/)
* [libconfig++](https://github.com/hyperrealm/libconfig)
* [libxdg-basedir](http://repo.or.cz/w/libxdg-basedir.git)
### Usage
You can create dynamic and static libraries:
```SH
mkdir build
cd build
cmake ..
make
make install
```
Or just copy `xdgcfg.hpp` and `xdgcfg.cpp` into your project folder.
### Documentation
`xdgcfg.hpp` has explanatory comments in it and there is an
[example](src/example.cpp).