Table of contents

• Installation
• Usage
• Contributing

Installation

Gitpod

By using Gitpod, you can skip all the steps which automatically installs all the necessary dependencies and builds the code.

Locally

1. Clone the Git repository and its submodules.

git clone --recursive https://github.com/realstealthninja/texto.git

2. Install dependencies (Unix/Linux).

sudo apt-get update && sudo apt-get install ninja-build libopencv-dev

Note:

Ninja Build and OpenCV are also available for MacOs and Windows. Check out their binary releases. https://github.com/opencv/opencv/releases https://github.com/ninja-build/ninja/releases

3. Build with CMake.

cmake -DCMAKE_BUILD_TYPE=Release -G Ninja -S ./ -B ./cmake-build-release
cmake --build ./cmake-build-release --target texto -j 1

Currently, Texto does not offer a prebuilt package. but it doesn't take a lot to compile. You can also run build.sh, which runs the exact same commands above.

Usage

./texto <PATH-TO-FILE> <COLOURSPACE>

Want to contribute?

Please do raise an issue before opening a pull request discussing on how you are implementing the feature.