Skip to content

Commit 479af6f

Browse files
committed
README update
1 parent 436c0ee commit 479af6f

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
<a href="https://www.buymeacoffee.com/st1vms"><img src="https://img.buymeacoffee.com/button-api/?text=1 Pizza Margherita&emoji=🍕&slug=st1vms&button_colour=0fa913&font_colour=ffffff&font_family=Bree&outline_colour=ffffff&coffee_colour=FFDD00" /></a>
22
# dynamic-bits
3-
43
## Table of content
54

65
- [Overview](#overview)
76
- [Installation](#installation)
87
- [Manual (Linux)](#manual-linux-installation)
8+
- [Requirements (Linux)](#requirements-linux)
99
- [Manual (Android)](#manual-android-installation)
10+
- [Requirements (Android)](#requirements-android)
1011
- [Uninstalling](#uninstalling)
1112
- [Usage](#usage)
1213
- [Notes](#notes)
1314

15+
-------------------------------------
16+
1417
## Overview
1518

1619
This is a serialization library that supports **variable length integers/doubles**, **UTF8 strings** and serialization of **boolean bits**.
@@ -22,12 +25,18 @@ Each "packet" is defined in a packet table, a fixed number of fields is assigned
2225

2326
Programmers must register their packets in the table before any de/serialization activity, this way thread safety can be achieved.
2427

28+
-------------------------------------
29+
2530
## Installation
2631

2732
For now only Linux manual installation option is available, along with Android binding...
2833

2934
## Manual-Linux-Installation
3035

36+
### Requirements-Linux
37+
38+
- [cmake](https://cmake.org/install/) is required in order to build this library.
39+
3140
After downloading the git repository, move into the downloaded directory, make a build folder and generate build files using cmake.
3241
```
3342
git clone https://github.com/st1vms/dynamic-bits
@@ -46,6 +55,8 @@ sudo make install
4655
sudo ldconfig /usr/local/lib
4756
```
4857

58+
-------------------------------------
59+
4960
## Uninstalling
5061

5162
Run these two commands inside project folder...
@@ -54,8 +65,10 @@ chmod u+x uninstall.sh
5465
sudo ./uninstall.sh
5566
```
5667

57-
## Manual-Android-Installation
68+
-------------------------------------
5869

70+
## Manual-Android-Installation
71+
- Install [Android Studio](https://cmake.org/install/) if not already installed.
5972
- Open the JDBits bind project inside Android Studio
6073
- After syncing gradle files, open a terminal and execute this command:
6174
```
@@ -66,13 +79,17 @@ You will find the generated **jdbits-<build_version>.aar** file inside the `buil
6679
6780
Copy the AAR file into your Android project **`libs`** folder, and import is as an **`implementation`** dependency, using the Android Studio dependency manager in your Project Settings.
6881
82+
-------------------------------------
83+
6984
## Usage
7085
7186
Please refer to the examples provided in the [examples](examples/) folder, for the specific language/platform you're using...
7287
7388
- [C-Example](examples/c-example/)
7489
- [Android-Java-Example](examples/android-example/app/src/main/java/com/example/dbitsandroidexample/MainActivity.java)
7590
91+
-------------------------------------
92+
7693
## Notes
7794
7895
This library doesn't still support complex structures, such as arrays, unions, dictonaries, etc...

0 commit comments

Comments
 (0)