Added readme

This commit is contained in:
rexy712 2018-11-24 09:16:12 -08:00
parent 621804989b
commit b125c35f25

30
README.md Normal file
View File

@ -0,0 +1,30 @@
# README
## About
rjp (rexy's json parser) is a very simplistic json parser written in C. There is absolutely no reason for this to exist but I felt like making it :P
Currently only installs 2 files: librjp.a and rjp.h
## Building
Building will produce a static library with no option to create shared because it's such a simple library.
##### Run the following commands
```
mkdir build
cd build
ccmake ..
#or jest 'cmake ..' and specify options on the command line
make
```
## Installing
##### Run the following commands from the bulid directory after building
```
sudo make install
```
## Uninstalling
##### Run the following commands from the build directory
```
sudo make uninstall
```