zecfoundation
/
zebra-launcher
mirror of https://github.com/ZcashFoundation/zebra-launcher.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md with screenshots and installation instructions

This commit is contained in:
Arya 2024-03-12 22:54:56 -04:00 committed by GitHub
parent ae263c8e9f
commit e3d419dee3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -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
<img src="https://github.com/ZcashFoundation/zebra-app/assets/5491350/4fb8b310-15e7-47be-8650-18a24b733ebc" width="480">
&nbsp;
<img src="https://github.com/ZcashFoundation/zebra-app/assets/5491350/564bef27-5b82-4f1e-8e9f-af709bf48528" width="480">
## 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)