Skip to content

Commit

Permalink
docs: add dependency install instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
emccorson committed May 23, 2023
1 parent 1f591dd commit f231375
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,41 @@ namada-interface/

### Usage

Before using apps in this repo, we first need to install all dependencies:
Before using apps in this repo, we first need to install all
dependencies. Note that these commands are for Ubuntu and will vary on
other systems:

```bash
# Install rustup
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Add WASM target
rustup target add wasm32-unknown-unknown

# Install clang
sudo apt-get install -y clang

# Install pkg-config
sudo apt-get install -y pkg-config

# Install openssl development packages
sudo apt-get install -y libssl-dev

# Install wasm-bindgen-cli
cargo install wasm-bindgen-cli

# Install protoc
sudo apt-get install -y protobuf-compiler

# Install wasm-pack
curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh

# Install yarn and JS dependencies
npm install -g yarn
yarn

# Install web-ext
yarn global add web-ext
```

At the root-level, we can issue commands for all packages in the monorepo. Following is an example:
Expand All @@ -84,6 +115,8 @@ yarn lint
yarn lint:fix
```

There are also app-specific instructions in the [namada-interface README](apps/namada-interface/README.md) and the [extension README](apps/extension/README.md).

### Project Structure

The app is split in 4 major parts: `App`, `Components`, `State`, `Utils`.
Expand Down

0 comments on commit f231375

Please sign in to comment.