diff --git a/README.md b/README.md new file mode 100644 index 0000000..cd8ba4d --- /dev/null +++ b/README.md @@ -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` \ No newline at end of file