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

Updated installation instructions #411

Merged
merged 4 commits into from
Jul 8, 2020
Merged
Show file tree
Hide file tree
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
57 changes: 38 additions & 19 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,36 @@

## Table of contents

* Packages
* [Distribution-specific packages](#distribution-specific-packages)
- [Arch-based distributions](#arch-based-distributions)
- [Debian](#debian)
- [Fedora](#fedora)
- [OpenMandriva](#openmandriva)
- [openSUSE](#opensuse)
- [Pop!\_OS](#pop_os)
- [Ubuntu-based distributions](#ubuntu-based-distributions)
* [AppImage](#appimage)
* [Flatpak](#flatpak)
* [Portable packages](#portable-packages)
- [AppImage](#appimage)
- [Flatpak](#flatpak)
* [Prebuilt releases](#prebuilt-releases)
* [Source](#source)
* [Build from source](#build-from-source)
- [Dependencies](#dependencies)
- [Building](#building)
- [Installing](#installing)
- [Debian and Ubuntu-based distributions](#debian-and-ubuntu-based-distributions)
- [Other distributions](#other-distributions)

## Distribution-specific packages

### Arch-based distributions
[`gamehub-git`](https://aur.archlinux.org/packages/gamehub-git) and [`gamehub`](https://aur.archlinux.org/packages/gamehub) are available in AUR.

### Debian
Prebuilt .deb packages from [releases page](https://github.com/tkashkin/GameHub/releases) were not tested on Debian, but should work.

Alternatively you can build a package from source:
Install Debian package from the [releases page](https://github.com/tkashkin/GameHub/releases) or import the [PPA](https://launchpad.net/~tkashkin/+archive/ubuntu/gamehub):
```bash
git clone https://github.com/tkashkin/GameHub.git
cd GameHub
scripts/build.sh build_deb
sudo apt install dirmngr
sudo sh -c "echo 'deb http://ppa.launchpad.net/tkashkin/gamehub/ubuntu focal main' > /etc/apt/sources.list.d/gamehub-ppa.list
sudo apt-key adv --recv-keys --keyserver keyserver.ubuntu.com 5B63B42CE14BA47CC1B69E7C32B600D632AF380D
sudo apt update
sudo apt install com.github.tkashkin.gamehub
```
### Fedora
Expand Down Expand Up @@ -62,17 +65,19 @@ sudo apt update
sudo apt install com.github.tkashkin.gamehub
```
## AppImage
## Portable packages
### AppImage
AppImages can be found in the [releases page](https://github.com/tkashkin/GameHub/releases).
**WARNING: AppImages are unstable! You might experience issues.**
## Flatpak
### Flatpak
Flatpak releases can be found in the [releases page](https://github.com/tkashkin/GameHub/releases).
**WARNING: Flatpak releases are unstable! You might experience issues.**
Then install the package by executing this command:
Install the package by executing this command:
```bash
flatpak install GameHub-*.flatpak
```
Expand All @@ -87,7 +92,7 @@ scripts/build.sh build_flatpak
## Prebuilt releases
Prebuilt releases can be found in the [releases page](https://github.com/tkashkin/GameHub/releases).
## Source
## Build from source
### Dependencies
* `meson`
Expand All @@ -104,15 +109,29 @@ Prebuilt releases can be found in the [releases page](https://github.com/tkashki
* `libunity-dev` (optional, required for launcher icon quicklist, progress indicator and counter; pass `-Duse_libunity=true` to `meson` to use)
* `libmanette-0.2-dev`, `libx11-dev`, `libxtst-dev` (optional, required for gamepad support)
### Building
### Debian and Ubuntu-based distributions
* Build a .deb package (this will build `GameHub-*.deb` package in the parent directory):
```bash
git clone https://github.com/tkashkin/GameHub.git
cd GameHub
scripts/build.sh build_deb
```
* Install built package:
```bash
sudo apt install ../GameHub-*.deb
```
### Other distributions
* Build:
```bash
git clone https://github.com/tkashkin/GameHub.git
cd GameHub
meson build --prefix=/usr --buildtype=debug
cd build
ninja
```
### Installing
```
* Install:
```bash
sudo ninja install
```
Do not remove build directory if you want to uninstall GameHub later, build directory is used in uninstallation process.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ GameHub supports:
See [INSTALL.md](INSTALL.md).

## Building
See [INSTALL.md#Source](INSTALL.md#source).
See [INSTALL.md#Source](INSTALL.md#build-from-source).

## [Screenshots](https://tkashkin.tk/projects/gamehub/#/screenshots)
<p align="center"><img src="data/screenshots/light/welcome.png?raw=true" width="49%" /> <img src="data/screenshots/dark/grid.png?raw=true" width="49%" /><img src="data/screenshots/dark/list.png?raw=true" width="49%" /> <img src="data/screenshots/light/grid_controller.png?raw=true" width="49%" /><img src="data/screenshots/light/details.png?raw=true" width="49%" /> <img src="data/screenshots/dark/settings_collection.png?raw=true" width="49%" /><img src="data/screenshots/dark/overlays.png?raw=true" width="49%" /> <img src="data/screenshots/light/install.png?raw=true" width="49%" /><img src="data/screenshots/light/properties.png?raw=true" width="49%" /> <img src="data/screenshots/dark/install_compat.png?raw=true" width="49%" /></p>