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

Revamped documentation #407

Merged
merged 11 commits into from
Jul 8, 2020
Merged

Revamped documentation #407

merged 11 commits into from
Jul 8, 2020

Conversation

TheEvilSkeleton
Copy link
Contributor

@TheEvilSkeleton TheEvilSkeleton commented Jun 26, 2020

Decided to revamp the documentations because it was a bit hard to understand

@TheEvilSkeleton TheEvilSkeleton changed the title WIP: Revamped documentation Revamped documentation Jun 26, 2020
INSTALL.md Outdated
[`gamehub-git`](https://aur.archlinux.org/packages/gamehub-git/) and [`gamehub`](https://aur.archlinux.org/packages/gamehub/) are available in AUR.

## Debian
Unfortunately, there is no package available in the Debian repository, so it will be required to run the [`/scripts/build.sh build_deb`](../scripts/build.sh#L171-L210) script. The script will install the dependencies and GameHub.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't actually tried it on Debian, but I think packages for Ubuntu should install on Debian if dependencies are available in repos.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that may be true, but PPAs have been prone to break in Debian since they were made specifically for Ubuntu. i wouldn't recommend adding PPAs if you are risking breakage

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be possible to just download prebuilt .deb from releases page and install it on Debian without adding any repos (if all of dependencies are actually available in Debian repos).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'll install a Debian VM and will test. hope it works

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's taking a while to install

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sad. seems like Debian doesn't want to boot after waiting an hour and half of installing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tried a livecd, it doesn't boot either. i can't really test

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't actually tried it on Debian, but I think packages for Ubuntu should install on Debian if dependencies are available in repos.

i would suggest we can add a warning that the .deb hasn't been tested in Debian, so users may experience issues

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can test
Gimme a few mins

Copy link
Contributor

@Scupake Scupake Jul 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Used the PPA, nothing broke, the commands are different though. I think that the granite package could cause some packages to break, not sure though. (btw I have no idea how to do the suggestions thing lol)

Debian

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 install com.github.tkashkin.gamehub

INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Outdated Show resolved Hide resolved
INSTALL.md Outdated Show resolved Hide resolved
@TheEvilSkeleton
Copy link
Contributor Author

replying to this #407 (comment)

do you think that we should add a warning for the Flatpak'd version?

@tkashkin
Copy link
Owner

Yes, warning may be useful. Currently both flatpak and AppImage builds have some issues which may or may not be fixed in the future.

@TheEvilSkeleton
Copy link
Contributor Author

Yes, warning may be useful. Currently both flatpak and AppImage builds have some issues which may or may not be fixed in the future.

Done 908ef14

@tkashkin tkashkin merged commit 510834f into tkashkin:master Jul 8, 2020
@tkashkin
Copy link
Owner

tkashkin commented Jul 8, 2020

Thanks, documentation definitely needs improvements. Feel free to add suggestions to the readme, wiki or homepage.

@TheEvilSkeleton
Copy link
Contributor Author

unfortunately, i'm terrible with HTML, but i can help you improve the README and the wiki

tkashkin pushed a commit that referenced this pull request Sep 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants