Skip to content

Commit bd16eb6

Browse files
committed
Add getting-started.md
1 parent c7a09ad commit bd16eb6

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,8 @@ The most downloaded and probably the only available library to polyfill this met
4141
### Benchmark
4242

4343
_TODO_
44+
45+
46+
### Notes
47+
48+
- [Get started with the development of the module](./docs/getting-started.md)

docs/getting-started.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Getting started
2+
3+
To get started with the development of the module a couple steps are necessary:
4+
5+
1. `yarn` / `yarn install` on the root of the project to install both the dependencies for the module and for the example app
6+
2. Provide compiled sources for `libsodium` in `./Clibsodium.xcframework` and `libsodium-android`
7+
3. Into `example/ios` run `pod install` to install the pods
8+
4. By running `npm run start` in the `example` folder you should now be able to start the Example App
9+
5. Open `example/ios` in Xcode to start screwing around the native module and the native code.

0 commit comments

Comments
 (0)