Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
st1vms committed Apr 11, 2023
1 parent 436c0ee commit 479af6f
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
<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>
# dynamic-bits

## Table of content

- [Overview](#overview)
- [Installation](#installation)
- [Manual (Linux)](#manual-linux-installation)
- [Requirements (Linux)](#requirements-linux)
- [Manual (Android)](#manual-android-installation)
- [Requirements (Android)](#requirements-android)
- [Uninstalling](#uninstalling)
- [Usage](#usage)
- [Notes](#notes)

-------------------------------------

## Overview

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

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

-------------------------------------

## Installation

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

## Manual-Linux-Installation

### Requirements-Linux

- [cmake](https://cmake.org/install/) is required in order to build this library.

After downloading the git repository, move into the downloaded directory, make a build folder and generate build files using cmake.
```
git clone https://github.com/st1vms/dynamic-bits
Expand All @@ -46,6 +55,8 @@ sudo make install
sudo ldconfig /usr/local/lib
```

-------------------------------------

## Uninstalling

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

## Manual-Android-Installation
-------------------------------------

## Manual-Android-Installation
- Install [Android Studio](https://cmake.org/install/) if not already installed.
- Open the JDBits bind project inside Android Studio
- After syncing gradle files, open a terminal and execute this command:
```
Expand All @@ -66,13 +79,17 @@ You will find the generated **jdbits-<build_version>.aar** file inside the `buil
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.
-------------------------------------
## Usage
Please refer to the examples provided in the [examples](examples/) folder, for the specific language/platform you're using...
- [C-Example](examples/c-example/)
- [Android-Java-Example](examples/android-example/app/src/main/java/com/example/dbitsandroidexample/MainActivity.java)
-------------------------------------
## Notes
This library doesn't still support complex structures, such as arrays, unions, dictonaries, etc...
Expand Down

0 comments on commit 479af6f

Please sign in to comment.