Skip to content

Commit

Permalink
Cleanup README
Browse files Browse the repository at this point in the history
  • Loading branch information
singpolyma committed Oct 9, 2024
1 parent ba48b44 commit 34f7d98
Showing 1 changed file with 13 additions and 26 deletions.
39 changes: 13 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -14,43 +19,25 @@ Also some typings are generated which include documenation comments.

libsnikket.so and cpp/snikket.h, the latter has documentation comments

<details>
<summary>
## Alpine Linux

## Build dependencies
</summary>

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
```
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.
</details>

# Swift

Expand Down

0 comments on commit 34f7d98

Please sign in to comment.