Refer to the Contributing page.
There are two methods to build Bottles. The first and longer method is using org.flatpak.Builder
, and the second but shorter method is building directly.
- Install
org.flatpak.Builder
from Flathub - Clone
https://github.com/bottlesdevs/Bottles.git
(or your fork) - Run
flatpak run org.flatpak.Builder --install --install-deps-from=flathub --default-branch=master --force-clean build-dir com.usebottles.bottles.yml
in the terminal from the root of the repository (use--user
if necessary) - Run
flatpak run com.usebottles.bottles//master
to launch it
Since Bottles is primarily and officially distributed as a Flatpak, we only provide instructions to directly build it inside a Flatpak environment:
- Download and install the latest build of Bottles: bottles-x86_64.zip. Unzip it, and run
flatpak install bottles.flatpak
(use--user
if necessary) - Run
flatpak run -d --filesystem=$PWD --command=bash com.usebottles.bottles//master
from the root of the repository, followed by./utils/install.sh
. This will build Bottles and install it under thebuild/
directory. - Run
./build/bin/bottles
to launch Bottles
Due to GNOME Builder limitations, Builder cannot build Bottles for the time being; see GNOME/gnome-builder#2061 for more context. This is the best workaround we can provide.
This project follows the GNOME Code of Conduct. You are expected to follow it in all Bottles spaces, such as this repository, the project's social media, messenger chats and forums. Bigotry and harassment will not be tolerated.