Add readme with build instrucitons

This commit is contained in:
Krishan
2022-04-29 20:13:18 +05:30
parent 7be304362c
commit d4538f8262

17
README.md Normal file
View File

@@ -0,0 +1,17 @@
# Cinny desktop
## Local development
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:
* `npm run tauri build`
To start local dev server, run:
* Open cinny submodule dir in terminal and run `npm start`
* Now main dir in another termial window run `npm run tauri dev`