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.
xdgjson/README.md

32 lines
834 B
Markdown
Raw Permalink Normal View History

2018-08-10 03:28:31 +02:00
**xdgjson** is a very simple wrapper around jsoncpp written in C++. It reads
and writes files in `${XDG_CONFIG_HOME}`. It creates subdirectories if
necessary.
### Dependencies
2018-08-11 08:44:01 +02:00
* C++ compiler (Tested: g++ 5/6/7/8)
2018-08-10 03:28:31 +02:00
* [cmake](https://cmake.org/)
* [pkgconfig](https://pkgconfig.freedesktop.org/wiki/)
* [jsoncpp](https://github.com/open-source-parsers/jsoncpp)
* [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 `xdgjson.hpp` and `xdgjson.cpp` into your project folder.
### Documentation
`xdgjson.hpp` has explanatory comments in it and there is an
[example](src/example.cpp). The reference is also available at
[doc.schlomp.space/xdgjson/](https://doc.schlomp.space/xdgjson/classxdgjson.html).