Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add AUR installation instructions to 'README.md' #112

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 34 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## Support
For anything that isn't an issue in Celeste's functionality, visit the project's [Discord server](https://discord.gg/FtNhPepvj7), where you can obtain support and chat with fellow users. If you have a bug/feature request for Celeste, then make a new issue in the project's [issue tracker](https://github.com/hwittenborn/celeste/issues).

Expand Down