MCorange/cinny-desktop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme with setup instructions.

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/test.yml vendored
View File

@@ -36,4 +36,6 @@ jobs:
- name: Build desktop app with Tauri - name: Build desktop app with Tauri
uses: tauri-apps/tauri-action@v0.3.0 uses: tauri-apps/tauri-action@v0.3.0
env: env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
TAURI_PRIVATE_KEY: ${{ secrets.TAURI_PRIVATE_KEY }}
TAURI_KEY_PASSWORD: ${{ secrets.TAURI_KEY_PASSWORD }}

7
README.md
View File

@@ -1,15 +1,18 @@
# Cinny desktop # Cinny desktop
Dekstop app of Cinny made with Tauri. Cinny is a matrix client focusing primarily on simple, elegant and secure interface.
## Local development ## 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` * `git clone --recursive https://github.com/cinnyapp/cinny-desktop.git`
* `cd cinny` * `cd cinny`
* `npm ci` * `npm ci`
* `cd ..` * `cd ..`
* `npm ci` * `npm ci`
Now to build the app locally, run: To build the app locally, run:
* `npm run tauri build` * `npm run tauri build`
To start local dev server, run: To start local dev server, run: