gitbutlerapp/gitbutler
1
1
Fork 0
mirror of https://github.com/gitbutlerapp/gitbutler.git synced 2024-08-17 00:00:31 +03:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Nikita Galaiko 2023-02-03 16:23:13 +01:00
parent 9d46707972
commit 08d3f340dc
No known key found for this signature in database
GPG Key ID: EBAB54E845BA519D
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,20 +1,36 @@
## prerequisites
## development
### prerequisites
[see here](https://tauri.app/v1/guides/getting-started/prerequisites)
for the list of software required to build / develope the app.
## setup
### setup
then, make sure to install app dependencies:
```bash
$ cd src-tauri/binaries && make
$ pnpm install
```
## development
### run
now you should be able to run the app in development mode:
```bash
$ pnpm tauri dev
```
## building
to build the app in production mode, run:
```bash
$ cd src-tauri/binaries && make
$ pnpm tauri build
```
## releasing
Releasing is done via [GitHub Action](https://github.com/gitbutlerapp/gitbutler-client-tauri/actions/workflows/publish.yaml).