diff --git a/README.md b/README.md index ffb8157..061482d 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,30 @@ A Desktop app for installing and running Zebra. -## Recommended IDE Setup +## Installation -- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) +To install the Zebra App: -## Setup +1. Download the installer for your operating system from the Github releases [here](https://github.com/ZcashFoundation/zebra-app/releases/tag/v0.0.0-alpha.1). +2. Run the installer + +Note: On macOS, it currently requires an ARM-based processor such as the Apple M1. + +## Screenshots + + +  + + +## Developer Setup 1. Make sure all of the [Tauri prerequisites](https://beta.tauri.app/guides/prerequisites/) are installed. 2. Install `pnpm` 3. Run `pnpm i` to install npm packages 4. Run `pnpm tauri dev` to start the Tauri app. 5. Add an empty `dist` folder to the root of this project to fix the Rust warning in `src-tauri/src/main.rs` -6. Install Prettier for formatting .ts/.tsx/.css files +6. Install `Prettier` for formatting .ts/.tsx/.css files + +#### Recommended IDE Setup + +- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)