git » sdk » commit ba48b44

add alpine build instructions

author Anjandev Momi
2024-10-06 20:12:17 UTC
committer Stephen Paul Weber
2024-10-09 14:03:53 UTC
parent 871118d1594e1f1bc9f406a0374d5fa7c3fa9998

add alpine build instructions

README.md +38 -0

diff --git a/README.md b/README.md
index c0d9179..0e81c73 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,44 @@ Also some typings are generated which include documenation comments.
 
 libsnikket.so and cpp/snikket.h, the latter has documentation comments
 
+## Alpine Linux
+
+## Build dependencies
+
+Build haxelib and neko from this aports branch:
+
+https://gitlab.alpinelinux.org/alpine/aports/-/merge_requests/69597
+
+Install the required make dependencies:
+
+``` sh
+doas apk add opus-dev libdatachannel-dev libstrophe-dev libc++-dev musl-dev --virtual snikket-sdk-makedeps
+```
+
+Building the sdk requires a `xlocale.h` file which is the same as the `locale.h` on your computer (provided by the `musl-dev` package).
+
+
+``` sh
+doas ln -s /usr/include/locale.h /usr/include/xlocale.h
+```
+
+Install each of the haxe dependencies with each dependency on a new line:
+
+``` sh
+    haxelib install datetime
+    haxelib install haxe-strings
+    haxelib install ...
+```
+
+Build the c library using:
+
+``` sh
+make libsnikket.so
+```
+
+On completion, you can find `libsnikket.so` library at`./cpp/output.dso` and the `snikket.h` header file at `./cpp/snikket.h`.
+
+
 # Swift
 
 libsnikket.so and cpp/snikket.h are wrapped by cpp/Snikket.swift