Update readme with setup instructions.

This commit is contained in:
Krishan
2022-05-03 21:20:25 +05:30
parent 871b0eb0f2
commit c1d3e3c838
2 changed files with 8 additions and 3 deletions

View File

@@ -1,15 +1,18 @@
# Cinny desktop
Dekstop app of Cinny made with Tauri. Cinny is a matrix client focusing primarily on simple, elegant and secure interface.
## Local development
To setup development locally run the following commands:
Firstly, to setup Rust, NodeJS and build tools follow [Tauri documentation](https://tauri.studio/docs/getting-started/prerequisites).
Now, to setup development locally run the following commands:
* `git clone --recursive https://github.com/cinnyapp/cinny-desktop.git`
* `cd cinny`
* `npm ci`
* `cd ..`
* `npm ci`
Now to build the app locally, run:
To build the app locally, run:
* `npm run tauri build`
To start local dev server, run: