Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs: add common building error and correct dependencies #7725

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion doc/BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ own. If you prefer the auto-update feature, you can use the official [mail](http
* An up-to-date version of Git is installed
* Node.js (check package.json `engines` field for the version)
* Emscripten 3.1.59
* WASM2JS (Included in Emscripten)
* WASM2JS (included in binaryen)

#### Build steps:

Expand All @@ -25,6 +25,16 @@ own. If you prefer the auto-update feature, you can use the official [mail](http
11. Run the local server. Either use `node server` or `python -m SimpleHTTPServer 9000`.
12. Open `localhost:9000` with your favorite browser (tested: Firefox, Chrome/Chromium, Safari).

> If you try building without initializing the submodules, you might end up with
> the following error:
>
> ```
> Build error: Error: Could not load wasm-loader:liboqs.wasm (imported by src/common/api/worker/facades/KyberFacade.ts): Command failed: make -f Makefile_liboqs build
> liboqs/src/kem/kem.c:12:10: fatal error: 'oqs/oqs.h' file not found
> ```
>
> Just delete the `libs/webassembly/include` directory and re-build.

## Building and running your own Tuta Mail Android app

If you build and install the Tuta Mail Android app by yourself, keep in mind that you will not get updates automatically.
Expand Down