Skip to content

Commit 903e15d

Browse files
authored
Update README.md
1 parent f188137 commit 903e15d

File tree

1 file changed

+28
-6
lines changed

1 file changed

+28
-6
lines changed

README.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,30 @@
11
[![CJLIB](https://github.com/constarg/cjlib/actions/workflows/cjlib.yml/badge.svg?branch=main)](https://github.com/constarg/cjlib/actions/workflows/cjlib.yml)
2-
# cjlib
3-
C library for reading/writing json format files
2+
# Introduction
43

5-
# PROJECT STALLED.
6-
- CURRENTLY WORKING PART: The library successfully parses any JSON file and store's it in the memory as a AVL BStree.
7-
- DEVELOPMENT PART: Restore the object to the string version, given the AVL BStree.
8-
- I'm stopping the development for now, i will implement the last part at some other time.
4+
5+
# Installation Requirements
6+
7+
Before building the cjlib, make sure to install the necessary packages:
8+
9+
```bash
10+
sudo apt-get install build-essential git gcc
11+
```
12+
13+
# Download & Build
14+
15+
Get started by cloning the repository and navigating to the cjlib folder:
16+
```
17+
git clone https://github.com/constarg/cjlib.git
18+
cd cjlib/
19+
```
20+
Now, build the library using the following command:
21+
22+
```
23+
make
24+
```
25+
26+
# Debugging
27+
28+
# Doc
29+
30+
# Usage example

0 commit comments

Comments
 (0)