Quran Lab

Windows and Linux quick start

The C library for Windows and Linux: how to build it, where the key goes, and the quick start.

The native SDK is a C API for desktop apps and servers on x86-64, on Windows and Linux. There are no prebuilt binaries: the library is built from its release tag with CMake. The source is at github.com/Quran-Lab/tajweedformer-c.

Install

git clone --recurse-submodules --branch 2.0.2 https://github.com/Quran-Lab/tajweedformer-c
cd tajweedformer-c
cmake --preset linux && cmake --build --preset linux    # Windows: windows-clang

The key

Use a desktop key. A Windows app is identified by its package family name or AppUserModelID, a Linux app by its reverse-DNS app id. Never compile the key into shared source:

# the environment, or your app's config file
QURANLAB_KEY=qlk_v1_...

What it needs

  • Windows or Linux on x86-64.
  • CMake and a C compiler. There are no prebuilt binaries: the library is built from its release tag.
  • Audio from your app. The library has no microphone of its own: your app, or the system's recorder, hands it the samples.
  • A connection once. The model (58.9 MB for all four response times) downloads on first use and every file is verified; after that it runs offline.

Quick start

The quick start for this version is in the package's README: github.com/Quran-Lab/tajweedformer-c.