From ab4ee02afbe8240e53eff735f08f3aa41f99231a Mon Sep 17 00:00:00 2001 From: Hunter Wittenborn Date: Thu, 8 Jun 2023 02:40:45 -0500 Subject: [PATCH] Add AUR installation instructions to 'README.md' --- README.md | 37 ++++++++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ea40db10..9d7e61be 100644 --- a/README.md +++ b/README.md @@ -31,27 +31,58 @@ Celeste can currently connect to the following cloud providers: ## Installation Celeste can be installed via the methods listed below: -### Flatpak +### Official +These installation methods are maintained directly by Celeste maintainers. + +#### Flatpak Celeste is available on [Flathub](https://flathub.org/apps/details/com.hunterwittenborn.Celeste). First make sure you have [set up Flatpak](https://flatpak.org/setup/) on your system, and then run the following: ```sh flatpak install flathub com.hunterwittenborn.Celeste ``` -### Snap +#### Snap Celeste is available on the [Snap Store](https://snapcraft.io/celeste), which can be installed on any system that has Snap installed. ```sh snap install celeste ``` -### Prebuilt-MPR (Debian/Ubuntu) +#### Prebuilt-MPR (Debian/Ubuntu) If you're on Ubuntu 22.10 or later, you can install Celeste from the Prebuilt-MPR. First make sure [the Prebuilt-MPR is set up](https://docs.makedeb.org/prebuilt-mpr/getting-started/) on your system, and then run the following: ```sh sudo apt install celeste ``` +### Community-Maintained +These installation methods are maintained by members of the Celeste community. They should work just fine, but if for any reason they don't and an issue arrises, you may be asked to reach out to the package's maintainer. + +#### AUR (Arch Linux) +> This package is maintained by [Mark Wagie](https://github.com/yochananmarqos). + +If you're on Arch Linux, you can install Celeste from the [AUR](https://aur.archlinux.org/packages/celeste). + +You can install it with your preferred [AUR helper](https://wiki.archlinux.org/title/AUR_helpers) such as [Yay](https://github.com/Jguer/yay) or [Paru](https://github.com/morganamilo/paru) (recommended): + +```sh +# Yay +yay -S celeste + +# Paru +paru -S celeste +``` + +or you can install it manually with [makepkg](https://wiki.archlinux.org/title/makepkg): + +```sh +git clone 'https://aur.archlinux.org/celeste' +cd celeste/ +makepkg -si +``` + +Note that you'll have to manually update Celeste if you install with makepkg though. + ## Contributing Instructions still largely need to be written up - if you'd like to help with that, feel free to submit a PR!