From c1d3e3c8383e07f1dde822af2dcc3d0a14a3e88e Mon Sep 17 00:00:00 2001 From: Krishan <33421343+kfiven@users.noreply.github.com> Date: Tue, 3 May 2022 21:20:25 +0530 Subject: [PATCH] Update readme with setup instructions. --- .github/workflows/test.yml | 4 +++- README.md | 7 +++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 31b62e7..ce67111 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -36,4 +36,6 @@ jobs: - name: Build desktop app with Tauri uses: tauri-apps/tauri-action@v0.3.0 env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + TAURI_PRIVATE_KEY: ${{ secrets.TAURI_PRIVATE_KEY }} + TAURI_KEY_PASSWORD: ${{ secrets.TAURI_KEY_PASSWORD }} \ No newline at end of file diff --git a/README.md b/README.md index cd8ba4d..2fd8269 100644 --- a/README.md +++ b/README.md @@ -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: