0
0
mirror of https://github.com/signalapp/libsignal.git synced 2024-09-19 19:42:19 +02:00

Add some basic build instructions to the readme

For those playing along at home
This commit is contained in:
Jack Lloyd 2020-11-12 16:12:19 -05:00
parent 9dc5f615ec
commit 5c12396a45

View File

@ -4,6 +4,53 @@ libsignal-client is an implementation of the Signal client in Rust.
Work in progress. Subject to change without notice, use outside Signal not yet recommended.
# Building
To build anything in this repository you must have Rust installed. The build currently
uses a specific version of the Rust nightly compiler (though probably most recent Rust
nightlies are fine).
```$ rustup toolchain add nightly-2020-11-09```
To build and test the basic protocol libraries just use ``cargo``:
```shell
$ cargo build
...
$ cargo test
...
```
## Java/Android
To build for Android you must install several additional packages including a JDK,
the Android NDK/SDK, and add the Android targets to the Rust compiler, using
```rustup target add armv7-linux-androideabi aarch64-linux-android i686-linux-android x86_64-linux-android```
To build the Java/Android ``jar`` and ``aar``, and run the tests:
```shell
$ cd java
$ ./gradlew test
```
Alternately, a setup using Docker is available:
```shell
$ cd java
$ make java_test
```
## Swift
To run the tests use
```shell
$ cd swift
$ swift test
```
# Legal things
## Cryptography Notice