From 348356cbf98a98f67354119e87b2f0b2ec282615 Mon Sep 17 00:00:00 2001 From: Eric Corson Date: Fri, 16 Aug 2024 19:50:28 +0900 Subject: [PATCH] chore: add README notice for Firefox reviewers --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/README.md b/README.md index ecea070e79..8c32244e2b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,44 @@ +NOTICE FOR FIREFOX ADD-ON REVIEWERS +=================================== + +This is the monorepo which contains the source code for Namada Extension. + +Source code +----------- +The main extension source code is located in `apps/extension/src`. We also use +several local packages; their source is in: + + - `packages/chains/src` + - `packages/components/src` + - `packages/hooks/src` + - `packages/sdk/src` + - `packages/storage/src` + - `packages/types/src` + - `packages/utils/src` + - `packages/shared/lib` (shared package Rust code compiled to WebAssembly) + - `packages/shared/src` (shared package TypeScript glue code) + - `packages/crypto/lib` (crypto package Rust code compiled to WebAssembly) + - `packages/crypto/src` (crypto package TypeScript glue code) + +Build instructions +------------------ +These instructions should work for the default reviewer build environment. + + sudo apt install protobuf-compiler build-essential + curl https://sh.rustup.rs -sSf | sh + npm install -g yarn + export PUPPETEER_SKIP_DOWNLOAD=true + yarn + cd apps/extension + yarn wasm:build + yarn build:firefox + +The resulting extension is the ZIP file in `apps/extension/build/firefox`. + +--- + +(The following are the usual contents of the README.) +

namada-interface