3.8 KiB
This article is also published in The FOSS Albatross.
Ever been linked to a GitHub page to download something and couldn’t figure out what to click? This short, simple guide will help you get to wherever you need in 4 easy steps.
What do all these words mean? Issues? Pull requests? Actions? Projects? Releases? ::
The README and wiki
Always remember to first RTFM (Read The Fine Manual, with a slightly different word in place of “fine”)! The README is always located on the home page of a repository, and it should contain a wealth of information for newcomers to familiarize themselves with the project. Installation instructions are often placed here if you scroll down far enough.
If that doesn’t work, check out the project’s wiki if they have one, located in the top navigation bar of the repository. Community members can also contribute to this page, so if you want to help the project and make it easier for newcomers, feel free to add or edit a page!
Downloading releases
Now, if neither the README nor wiki have any hints to finding the link you want, you can go to the Releases section of the project, which on a desktop browser is in the right sidebar, while on mobile is located at the very bottom of the page.
::image{src=“https://lh4.googleusercontent.com/v6G-c31NECe6ZJZhe2YSQXocQ4eCBJhYuXjNWSmECm5QQcSKaMWLpxe_roIkIonkMfUcDK4UtuqQEegVXCD1sAwHQnkssxOEk3uUrnQaMbhXL8zyeXdi0nUNv_QTKFsD5ZAUDJijHv_dc5wdTOEjggZipsIStM3vwaiabiNQ8XUY5bolApOupOwd”} In this case, clicking one of the “primoprod” assets with the file extension for your device will get you a runnable program. ::
Releases are the “official” way for projects to upload stable versions of their program to send to others. In the “Assets” section of a release, clicking the link that is not labeled “Source code” will get you a runnable version of the program.
Downloading repository files
Let’s say you don’t want to download the whole program, but instead just a certain file inside the repository. What do you do?
Similar to Google Drive and other cloud storage platforms, you can click through different folders and eventually on files. Although you can’t download folders, you can download individual files by clicking on them and then clicking “Raw” or “View Raw”.
If that doesn’t work, right-click the page that clicking “Raw” or “View Raw” opened and press “Save Page As”.
Filing issues
Trouble in paradise? If none of the above options worked, you can always file a new issue in the “Issues” tab of the project, where you can report bugs and ask questions directly to the project owner.
Remember to read the project’s issue guidelines, as some of them have a dedicated support forum or Discord to send help requests to.
Contribute to FOSS!
For those just trying to get a file and dip, GitHub’s interface is certainly more complex than it needs to be. The many buttons to streamline developers’ experiences often get in the way of a user just trying to download the program.
As a developer, though, GitHub’s many features are powerful and make development faster and more organised. If you ever decide to contribute to the FOSS community, return to GitHub and try to learn about the many other tools available to you!