From 34f7d983e7b8d9de784d13e2675ca7b88950ac5c Mon Sep 17 00:00:00 2001 From: Stephen Paul Weber Date: Wed, 9 Oct 2024 09:06:17 -0500 Subject: [PATCH] Cleanup README --- README.md | 39 +++++++++++++-------------------------- 1 file changed, 13 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 0e81c73..68bb044 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,12 @@ Working towards simplicity in developing Snikket-compatible apps. - haxelib install datetime haxe-strings hsluv tink_http sha thenshim + haxelib install datetime + haxelib install haxe-strings + haxelib install hsluv + haxelib install tink_http + haxelib install sha + haxelib install thenshim make # JavaScript @@ -14,9 +19,10 @@ 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: @@ -24,33 +30,14 @@ 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 -``` + 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). + doas ln -s /usr/include/locale.h /usr/include/xlocale.h -``` 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`. - +Install the haxe dependencies and run make as above. +
# Swift