Guake / guake-website

Source code for the Guake website
https://guake.github.io/
3 stars 9 forks source link

Directing users to get guake #11

Open FreeTheSmoke opened 3 years ago

FreeTheSmoke commented 3 years ago

Problem: The "How do I get Guake" section of website should make it clear that github tarballs are useful for inspecting source, but not building from. Result: Information path is guake-project.org -> github -> readthedocks Suggestion: Clarify about tarballs on guake-project.org. Add a direct link to the "install-from-source" section of readthedocs

Longer descripton with links-

  1. http://guake-project.org/ under "How can I get Guake?" states "Guake is packaged by a large number of distributions, among which are Fedora, Debian, Ubuntu and ArchLinux, so please check your repo. Source tarballs are available; see the Release Page" (links to https://github.com/Guake/guake/releases)

  2. https://github.com/Guake/guake#note-when-compiling-from-source states "Do NOT use the Tarball packages automatically generated by GitHub on the Release pages. They won't work because one of the main components of Guake build system, PBR, requires the full Git history to be available when building from source"

  3. Github then refers to the following link for installing from source https://guake.readthedocs.io/en/latest/user/installing.html#install-from-source

So my issue is not with the bold section of point 2, but just that point 1 is specifically about how do I Get Guake, so its a bit mean to point the would-be user at a dead end; It's a wonderful program and people should be able to get it as fast an easily as possible :) Thanks for developing it, I use it every day for the past 2 years now.

ulidtko commented 1 week ago

Hi @FreeTheSmoke, please reformulate your proposal as a PR.

Information in this comment might be helpful: https://github.com/Guake/guake-website/issues/17#issuecomment-2040278099