mirror
/
vorta
mirror of https://github.com/borgbase/vorta
1
0
Fork 0
Code Issues Releases Wiki Activity

Re-arrange CONTRIBUTING.md to add Flatpak description.

This commit is contained in:
Manu 2019-05-16 12:19:04 +08:00
parent 5444509d87
commit ce0f6b53e4
1 changed files with 33 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
CONTRIBUTING.md
View File

@ -7,47 +7,6 @@ All contributions that improve Vorta for everyone are welcome. Before coding a n
## Local Development Setup
### Linux
Follow the setup guide on [flatpak.org](http://flatpak.org/setup/) to make sure you have ``flatpak`` and ``flathub`` installed.
You also need to have ``flatpak-builder`` installed, which is usually available from the same repository as the ``flatpak`` package.
Install the org.kde 5.12 runtime and SDK
```
$ flatpak install flathub org.kde.Platform//5.12 org.kde.Sdk//5.12
```
Make a repo for your local builds (If you get the error: ``Remote listing for my-flatpak-builds not available; server has no summary file. Check the URL passed to remote-add was valid`` you can ignore it):
```
$ mkdir ~/my-flatpak-builds
$ flatpak remote-add --user --no-gpg-verify my-flatpak-builds ~/my-flatpak-builds
```
Clone the latest version of this repo:
```
$ git clone https://github.com/borgbase/vorta/
```
Next, in Vorta’s source directory, use ``flatpak-builder`` to build a Vorta flatpak and install it (this can take more than an hour):
```
$ cd vorta/flatpak/
$ mkdir app
$ flatpak-builder --repo=$HOME/my-flatpak-builds app com.borgbase.vorta.yaml
$ flatpak install --user my-flatpak-builds com.borgbase.vorta -y
```
Now you can work on the codebase.
When you want to test your changes you can execute inside of ``vorta/flatpak/``
```
$ flatpak-builder --repo=$HOME/my-flatpak-builds app com.borgbase.vorta.yaml --force-clean && flatpak update com.borgbase.vorta -y
$ flatpak run com.borgbase.vorta
```
### macOS
Clone the latest version of this repo:
```
$ git clone https://github.com/borgbase/vorta/
@ -68,6 +27,39 @@ Then run as Python script. Any changes from your source folder should be reflect
$ vorta
```
### Package with Flatpak
Follow the setup guide on [flatpak.org](http://flatpak.org/setup/) to make sure you have ``flatpak`` and ``flathub`` installed.
You also need to have ``flatpak-builder`` installed, which is usually available from the same repository as the ``flatpak`` package.
Install the org.kde 5.12 runtime and SDK
```
$ flatpak install flathub org.kde.Platform//5.12 org.kde.Sdk//5.12
```
Make a repo for your local builds (If you get the error: ``Remote listing for my-flatpak-builds not available; server has no summary file. Check the URL passed to remote-add was valid`` you can ignore it):
```
$ mkdir ~/my-flatpak-builds
$ flatpak remote-add --user --no-gpg-verify my-flatpak-builds ~/my-flatpak-builds
```
Next, in Vorta’s source directory, use ``flatpak-builder`` to build a Vorta flatpak and install it (this can take more than an hour):
```
$ cd vorta/flatpak/
$ mkdir app
$ flatpak-builder --repo=$HOME/my-flatpak-builds app com.borgbase.vorta.yaml
$ flatpak install --user my-flatpak-builds com.borgbase.vorta -y
```
Now you can work on the codebase.
When you want to test your changes you can execute inside of ``vorta/flatpak/``
```
$ flatpak-builder --repo=$HOME/my-flatpak-builds app com.borgbase.vorta.yaml --force-clean && flatpak update com.borgbase.vorta -y
$ flatpak run com.borgbase.vorta
```
## Working on the GUI
Qt Creator is used to edit views. Install from [their site](https://www.qt.io/download) or using Homebrew and then open the .ui files in `vorta/assets/UI` with Qt Creator:
```