Skip to content

DEVELOPERS.md

Latest commit

 

History

History
93 lines (53 loc) · 2.67 KB

DEVELOPERS.md

File metadata and controls

93 lines (53 loc) · 2.67 KB

Developer Manual

Coding Standard

lpac is written with C99 and compatible with SGP.22 version 2.2.2.

How to Compile

CMake

lpac uses CMake as its build system. Common build steps for all OSs look as follows:

# clone this repo in the top-level folder
git clone https://github.com/estkme-group/lpac.git
cd lpac

# configuration (this step can also include options -DOPTION=VALUE)
cmake -B build

# compilation
cmake --build build

If you want to package lpac in a relocatable directory, please build with -DSTANDALONE_MODE=ON, and then run command below to install files in directory.

DESTDIR=output cmake --install build

The resulting binary can then be found under build/output/executables folder.

Linux

Droidian

Same as normal Debian/Ubuntu, however, in order to build the GBinder backends, you will need libgbinder-dev, glib2.0-dev, and you will have to pass -DLPAC_WITH_APDU_GBINDER=ON when invoking cmake.

macOS

Install Homebrew.
Execute the same commands as you would do in Debian.

Windows(x86_64)

Windows needs libcurl.dll to run.
Download libcurl from https://curl.se/download.html and place it as libcurl.dll aside lpac.exe.

Install prerequisites and run CMake commands.

Build on Linux(MINGW)

Require build-essential cmake git g++ libpcsclite-dev libcurl4-openssl-dev gcc-mingw-w64 g++-mingw-w64 installed.

Build on Windows(MSYS2)

Require mingw-w64-x86_64-cmake mingw-w64-x86_64-gcc installed.

Build on Windows(Cygwin)

Require gcc-core gcc-g++ make cmake unzip wget installed.

To run it outside Cygwin shell, you need copy cygwin1.dll to the program folder to distribute.
cygwin1.dll is located in C:\cygwin64\bin\cygwin1.dll (Default Cygwin installation location)

Windows on ARM

Cross compile on Windows/Linux host (arm64, x86_64 and more architecture) with zig

See aarch64-windows-zig.cmake

Cross compile on Linux x86_64 host (GNU toolchain)

See linux-mingw64-woa.cmake

Build on Native Windows on ARM (MSYS2)

It is possible to build on WoA devices with MSYS2 ARM64 Support

You may need to install mingw-w64-clang-aarch64-cmake, mingw-w64-clang-aarch64-clang and modify cmake/linux-mingw64.cmake(replace toolchain).

Download prebuilt curl dll is also needed. Refer to the previous compilation steps.

Debug

Please see debug environment variables