Verified Commit 50fb559c authored by Pier Angelo Vendrame's avatar Pier Angelo Vendrame 🎃
Browse files

fixup! Create a README.md file

Add instructions to initialize the Glean submodule and other minor
fixes.
parent 8453931d
Loading
Loading
Loading
Loading
+18 −6
Original line number Diff line number Diff line
@@ -27,8 +27,6 @@ are generated using Uniffi when building each component.
The process to build this project is similar to the original build steps of
application-services with a few tweaks.

The following instructions assume you have cloned and initialized submodules.

> **Note**: For detailed information on the original steps, check out application-services
> own documentation at the [Application Services Book](https://mozilla.github.io/application-services/book/index.html).

@@ -39,7 +37,7 @@ The following instructions assume you have cloned and initialized submodules.
Before building application-services it's necessary to procure a build of our fork of
uniffi-rs. There are two possibilities for that, either you build it yourself:

```
```sh
git clone https://gitlab.torproject.org/tpo/applications/uniffi-rs.git
cd uniffi-rs
cargo build [--release]
@@ -47,13 +45,27 @@ cargo build [--release]

Or you can grab a build from https://tb-build-06.torproject.org/~tb-builder/tor-browser-build/out/uniffi-rs/

#### Initialize the glean submodule

Glean is included in this repository as a git submodule.

If you didn't clone this repository with the `--recursive` option, you will need
to update it before building:

```sh
git submodule update --init components/external/glean/
```

#### Setup

Once you got uniffi, you need to setup your environment:

```
```sh
cd libs
./build-all.sh desktop
export ANDROID_HOME=$HOME/.mozbuild/android-sdk-linux/
export ANDROID_NDK_HOME=$HOME/.mozbuild/android-ndk-r28b/
export ANDROID_NDK_ROOT=$ANDROID_NDK_HOME
./build-all.sh android
```

@@ -67,12 +79,12 @@ cd libs

Once setup is complete, building is as easy as:

```
```sh
./gradlew -PuniffiBindgenNoop="/path/to/the/uniffi-bindgen/binary" assemble(Release|Debug)
```

If you want to package it:

```
```sh
./gradlew -PuniffiBindgenNoop="/path/to/the/uniffi-bindgen/binary" publish
```