jabcode - color bar code
Switch branches/tags
Nothing to show
Clone or download
jabcode Merge pull request #9 from UniQP/moduleSize
Fix default module size documentation
Latest commit bb36d1d Nov 29, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
android_reader updated android reader. Oct 10, 2017
docs Add logo and interface images Nov 7, 2018
src Fix default module size documentation Nov 24, 2018
LICENSE Initial commit Jan 9, 2017
README.md Modify README to include logo, webinterface screenshot and the introd… Nov 7, 2018

README.md

JAB logo

JAB Code

JAB Code (Just Another Bar Code) is a high-capacity 2D color bar code, which can encode more data than traditional black/white (QR) codes. This repository contains a library for reading and writing JAB codes, along with sample applications. A demo webinterface is available at https://jabcode.org.

Introduction

JAB Code is a color two-dimensional matrix symbology whose basic symbols are made of colorful square modules arranged in either square or rectangle grids. JAB Code has two types of basic symbols, named as master symbol and slave symbol. A JAB Code contains one master symbol and optionally multiple slave symbols. Master symbol contains four finder patterns located at the corners of the symbol, while slave symbol contains no finder pattern. A slave symbol can be docked to a master symbol or another docked slave symbol in either horizontal or vertical direction. JAB Code can encode from small to large amount of data correlated to user-specified percentages of error correction.

A demo webinterface is provided to evaluate the library: JAB Demo Webinterface

Project Structure

.
├── docs                  # Documentation
├── spec                  # JAB Code specification
└── src                   # Source code
     ├── jabcode          # JAB Code core library
     ├── jabcodeReader    # JAB Code reader application
     └── jabcodeWriter    # JAB Code writer application

Build Instructions

The JAB Code core library, reader and writer applications are written in C (C11) and tested under Ubuntu 14.04 with gcc 4.8.4 and GNU Make 3.8.1.

Follow the following steps to build the core library and applications.

Step 1: Build the JAB Code core library by running make command in src/jabcode.

Step 2: Build the JAB Code writer by running make command in src/jabcodeWriter.

Step 3: Build the JAB Code reader by running make command in src/jabcodeReader.

The built library can be found in src/jabcode/build. The built reader and writer applications can be found in src/jabcodeReader/bin and src/jabcodeWriter/bin.

Usage

The usage of jabcodeWriter and jabcodeReader can be obtained by running the programs with the argument --help.

jabcodeReader

run jabcodeReader --help for the detailed usage

jabcodeWriter

run jabcodeWriter --help for the detailed usage

Documentation