Skip to content

Commit

Permalink
Introducing the next branch
Browse files Browse the repository at this point in the history
  • Loading branch information
giantpinkrobots committed Feb 12, 2024
1 parent 968c314 commit 6fb6073
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 5 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Contributions guide for Varia

If you have any questions you can always reach me via email ([email protected]) or through Matrix (@giantpinkrobots:matrix.org). Thanks! :)

## Code

If you want to contribute code, you mainly want the 'next' branch for things like new features that'll land in the next major version, as that branch is for active development. For important bug fixes however, you want the 'main' branch, so I can release a hotfix quickly from there without having to also release all the untested new features in development. These fixes can be applied to the 'next' branch later.

## Translations

In the case of translations, you want the 'next' branch unless if there is a really embarassing mistake that needs immediate correction with a hotfix, in which case you want the 'main' branch. Translations are done with .po files that you can create with a program like Poedit for example.

16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,17 @@ You can get Varia via the [AUR](https://aur.archlinux.org/packages/varia) as wel
### Windows (experimental)
You can find a *highly experimental* build of Varia in the releases section. But keep in mind, it will have bugs.

## Building (Linux)
## Building

The easiest way of building Varia is to use GNOME Builder. Just clone this repository, and open the folder using Builder. Then, press run.
There are two branches here: 'main' and 'next'. 'next' is where the feature developments for the next version happen.

If you don't want to utilize Flatpak to build Varia you need:
The 'main' branch can be built with the instructions below. The 'next' branch may also be built with these instructions, but it's not guaranteed. If you want to build the 'next' branch, it can be built with GNOME Builder on Linux.

### for Linux

The easiest way of building Varia is to use GNOME Builder. Just clone this repository, and open the folder using Builder. Then, press run. This is the way I make Varia, and the 'next' branch can only be reliably built this way.

To build Varia without Flatpak or GNOME Builder though, you'll need:
- meson
- python-setuptools
- Gtk4 and its development libraries
Expand Down Expand Up @@ -77,7 +83,7 @@ meson compile
sudo meson install
```

## Building (Windows)
### for Windows

Windows support is experimental. Translations don't work yet.

Expand Down Expand Up @@ -107,7 +113,7 @@ Running variamain.exe will start Varia.

## Contributing

Contributions are always welcome, of course! In the case of translations, they are done with .po files that you can create with a program like Poedit for example. Keep in mind that Varia is kind of a simple app at the moment, and I will keep adding new features so the translations you add right now can become incomplete when I add new features.
[Please refer to the contributing guide page.](https://github.com/giantpinkrobots/varia/blob/main/CONTRIBUTING.md)

## License

Expand Down

0 comments on commit 6fb6073

Please sign in to comment.