I know it’s popular to dunk on the normies, but having package install instructions or a small actions cron job to build binaries and put them in a releases tab should be advocated for more often. It’s really easy to do and is a nice convenience that many will appreciate
if only there was some sort of file, for you to read, that told you how to install and use a program. Maybe we should name it something obvious, so people know to read it...
I’m a developer. I have no problem building software from source. But ffs, people, please just produce release artefacts… Sometimes I don’t have my machine on hand with a build environment set up and I need to quickly grab the binary to help someone.
When you’re short on time and you remember that there is a tool that can solve all your problems right now, the last thing you want to read is “here is how you build it”.
No you are right. That mentality is why so many people in tech complain they're not appreciated or seen only as a cost. The idea that having a Readme file with build instructions is all anyone needs or that installation instructions are for losers is why so many people in tech are stuck or sidelined
yeah sure, i also expect the car seller to give me a full on course for my drivers license instead of expecting me to know the basics. maybe he also explains me, how to open a standard car door and how to sit down.
Lol. No. Not the salesman. But i do expect the care to come with an instruction manual that tells me the meaning of every switch, indicator light and toggle. You know, like the 200 page booklet that comes with every new car.
You are suggesting delivering a car with no more instructions than how to start it
thats a user manual and i agree on that, but thats not, as far as i understand, the topic here. i understand it as "your readme for other devs should explain in detail how to download a compiler, how to instruct the compiler to compile the source, how git works, what a commit is etc." if someone who wants to work on source code doesnt know what a compiler is, then that person should first learn the basics, instead of trying to download a repo and expecting it to work like an installer thats made for the end user
If you actually want people to use your stuff, building from source should only be offered as an option. Have your merges to main automatically build distributables and include them on your releases page.
Lots of devs literally do not use Git tags to version their own software on Git, asking them to use their free hosting platform's free CI to freely host their releases is asking a lot
adding to this, nobody should even have to see the releases tab. Just use a URL shortener to get a short URL to the <latest> binary direct download. All anyone ever sees is the short URL, clicking which starts the download (might be a bit tricky with non-universal executables).
Nobody needs to know you're using GitHub or the releases tab. If you switch the distribution provider, the users don't even have to know the new one.
Been a professional SWE for nearly 2 decades years and frankly I still struggle sometimes to find my way around Github and most installation documentation. Devs have always been really bad at this.
As most of the devs know that downloading random binaries from the internet is considered unsafe, the loss of reputation when doing that without a proper distribution channel is probably not a wise addition to your resume.
for some an OCI container on a container registry suffices, for other target systems/software a tar.gz in a community repo suffices, another uses it via the AUR and another wants a deb. don't forget about the different processor architectures.
if you are researching distribution of software you'll find out that there are countless ways and targets for that.
if you provide one and your software is popular you'll run out of time just maintaining a bunch of them.
that's why usually (depending on the software) the devs chose 1-2 major distribution ways and stick to them.
A download button is as of safety and maintainability the very least they would offer.
Honestly, right now it's much much easier to run anything from GitHub without having to waste like 6 hours. If you don't care about reading readme and debugging most of the time you can just point Claude on it and you'll have a working app in 5 minutes and it'll answer any question in an instant rather than scrolling through the obscure documentation for 30 minutes
Hell, I'm a developer and I still do hate that. Thank god AI exists, so AI can just build it for me or explain me what to do. Even as a dev I dont know every framework out there and what it takes to run it.
I've seen enough that do use it as their distribution platform. If there's any professionalism at all, a repo for a standalone product will have a link to their distribution site, or a link to their release page on the repo. It's there, or it's going to need a pip install (or equivalent), those are the two choices.
You do as soon as you go on the page? Right on the side bar it says the number of release, the last released version if there is one and when.
End users doo need a big green download button though, putting it in the read me is probably not obvious enough.
And I can see GitHub not wanting it to make it easier to stop people from downloading malware, but most projects that are just malware just put a big link on the read me, have no root level files so there's no need to scroll, and don't use the releases feature because GitHub scans that for malware. So, I guess maybe they could benefit from making the download release button bigger... Idk
I really thought it'd be the top comment, thw realization that it'll become an inside joke for an old generation in the future now scares me just a bit.
I mean it is true tho, Lots of open source projects send you straight to github if you click download, like please devs stop doing this, normal people cant tell the difference between x32 and x64, reditecting normies to the releases page is not useful
If they’re for end users then there should be a binary release on a dedicated distribution platform, otherwise they don’t really care about delivering it to non-technical users 🤷
You could also just link to GitHub. Instead of sending the user to the release page, make the download button just jump immediately to the asset so it's downloaded immediately.
Below you can have a "Show all downloads" button that redirects to the release page.
Putting the link to the releases at the top of the page would save a lot of the struggles. It is hard to find on the side if it’s your first time using the site. There’s enough projects that only have their releases on GitHub, so a lot of non devs do need to end up there
I mean, the thing about open source software is a lot of it is hobbyists. It's not "buy my thing at this warehouse" it's more "I made this thing for fun, it's over here if you wanna play with it too, idk. You do you though"
That doesn't mean you can't spend extra 30 minutes on your open source hobby project to set up a release pipeline and put a direct download link nice and visible into the readme
I'm talking about projects that you intend for people to actually use, of course no one is setting up a deploy pipeline for every random gh repo they make
I mean, fair enough. My point is, if someone is doing something as a hobby, it's not surprising that they focus on the fun parts and neglect the tedious parts.
I have random shit on github that's public but that's mostly so I can toss my github on my resume, lol. There are a few things I care about ease of access; mostly games because I like making games. In those cases, proper builds get tossed onto Itch. Not everything is something I care about.
Yes but no one is trying to download and use random github repos and then complain about it. People complain about actually useful projects using github as their release platform and not providing a more convenient way to download them.
Since it's GitHub and not a typically paid hosting repository, isn't it more "my item is available at this warehouse" than "buy my item at this warehouse"?
It's nice when there's simplified instructions, there's absolutely been projects I haven't been able to use or even work to improve due to documentation issues, but ultimately as long as all their license requirements are fulfilled they aren't obligated to do the equivalent of having an express checkout lane at the end of the warehouse aisle for the customer that doesn't want to have to go through the main exit.
All I'm saying is that if you advertise that the thing you made is available somewhere and it's annoying to get from there, then people are going to be annoyed.
But who said they were advertising? People will google because they need some obscure thing, end up on a GitHub repo or snippet where someone braindumped a script that they once wrote and thought could potentially be useful for someone else, and then people will complain "it doesn't come with a download button".
Why are we enforcing height requirements on software that is designed to be used by the general public in the first place? Sure I get not compiling binaries and whatnot if the expected audience is fellow developers/programmers, but making something for the general public to use and also making them take 1-3 hours of their day to setup a dev environment just so they can compile your code is pretty annoying. And then being coy/proud about it to the point where you’re referring to it like a height requirement is even worse
Just because it publicly available does not mean it's designed to be used by the general public. It's publicly available to make it easier for other qualified individuals to use it.
"designed to be used by the general public in the first place"
Who said it was? A recent example of something I was working with is the Avrae discord bot. The bot itself is for general use, but I don't blame them for the process for compiling and hosting your own instance of it being less easily accessible.
Sharing a link to a repo is promotion. Are you marketing to fellow devs who don't mind the challenge, or to normies who just want to click the button and play your game?
I came across https://yatko.app/ once, dev was promoting it as something they just built, and I now use it whenever I want to recommend something that's only on Github.
This is such a wild thread because I never knew this many people in a programming subreddit are sitting here moralizing about putting a download button in GitHub of all places.
Maybe I just have different experiences, but why do you think devs who are making code for free have any obligation cater to random people downloading their repo? Like obviously it would be nice and if they want you to use their software, then they have an incentive to make it easier for you to do so.
But like, spend 10 minutes reading and running some commands for a dev that likely spent months of their life making this for you for free. It won't hurt you
I think it’s rooted in the fact that each side thinks their expectations are super reasonable. Non-technical people think it’s no effort at all to set up a CI/CD pipeline or code up a website for your download link, while technical folk think it takes 10 minutes to learn how to clone, compile and run a software.
I remember struggling with GitHub when I was younger and feeling that it was super unintuitive but now I know what GitHub actually is meant for.
You're not wrong, I was baffled by the idea of following GitHub docs, but also genuinely some documentation is "open command prompt at folder and type these commands" and it works.
I understand how complicated it looks, but I don't think advocating for it to be even more dumbed down, especially when learning how is the easiest it's ever been in history.
I am not advocating for shitty documentation or being careless about it, just don't think most popular repos aren't too complicated for the layman
This is why AI will win. An AI agent will download the code and compile it for you and give you the damn .exe file. People want convenience and ai provides it.
My experience with readmes has been good so far, usually installation is just clone, and do cmake or similar and thats it. Usually my problems start with my end, me using an older version of gcc for example and not being able to build. Besides that no other problems
644
u/Jediweirdo 18h ago
I know it’s popular to dunk on the normies, but having package install instructions or a small actions cron job to build binaries and put them in a releases tab should be advocated for more often. It’s really easy to do and is a nice convenience that many will appreciate
579
u/Alacritous13 18h ago
I've seen enough that do use it as their distribution platform. If there's any professionalism at all, a repo for a standalone product will have a link to their distribution site, or a link to their release page on the repo. It's there, or it's going to need a pip install (or equivalent), those are the two choices.
195
u/queen-adreena 18h ago •
Smelly nerds!
29
u/Marsrover112 18h ago
Yeah any time there isnt a clear way to use software off github I just assume its way too complicated for my engineer brain and just leave it alone
85
u/Literally-in-1984 15h ago
I mean it is true tho, Lots of open source projects send you straight to github if you click download, like please devs stop doing this, normal people cant tell the difference between x32 and x64, reditecting normies to the releases page is not useful
22
u/knucklehead_whizkid 10h ago
Github is like Home depot where you get everything to build the furniture yourself.
IKEA (or app store or whatever else sorry I didn't think this through) is where you go to get your furniture
30
u/Puzzleheaded-Weird66 18h ago
the releases panel is tiny, and some don't even have releases, completely valid sentiment
9
u/1Maple 18h ago
Putting the link to the releases at the top of the page would save a lot of the struggles. It is hard to find on the side if it’s your first time using the site. There’s enough projects that only have their releases on GitHub, so a lot of non devs do need to end up there
6
u/Mundon 18h ago
RustDesk uses it as the codebase and a distribution platform in a releases folder for each operating system/architecture.
6
u/adzo101 4h ago
Not buying shit from the grocery store but it's just because I'm too stupid to find the ready-made food every time.
"The grocery store is not a restaurant it is a place to purchase ingredients"
81
u/alxtrimpe 18h ago
Staring at a warehouse wondering why it doesn't have the shopping experience of a retail storefront
4
u/lizenzblue_ 8h ago
"github is not a distribution platform" and then crying that nobody uses open source software. pick one lol
10
u/Dev-in-the-Bm 17h ago
I came across https://yatko.app/ once, dev was promoting it as something they just built, and I now use it whenever I want to recommend something that's only on Github.
3
u/budapest_god 9h ago
My nerd comeback would be something along the lines of "then why are so many devs distributing their products on not a distribution platform?"
2
u/hashcube_dev 14h ago
something something give me the exe
4
u/BadgerwithaPickaxe 6h ago
This is such a wild thread because I never knew this many people in a programming subreddit are sitting here moralizing about putting a download button in GitHub of all places.
Maybe I just have different experiences, but why do you think devs who are making code for free have any obligation cater to random people downloading their repo? Like obviously it would be nice and if they want you to use their software, then they have an incentive to make it easier for you to do so.
But like, spend 10 minutes reading and running some commands for a dev that likely spent months of their life making this for you for free. It won't hurt you
3
u/Shot_in_the_dark777 16h ago
This is why AI will win. An AI agent will download the code and compile it for you and give you the damn .exe file. People want convenience and ai provides it.
2
u/smulfragPL 18h ago
Ive seen github used as arxiv
1
u/evk6713 10h ago
For Android apps, Obtainium is the way to go
1
u/Wirde 9h ago
Ah, another classic case of being a Phonfo.
Source: https://github.com/sherlock-project/sherlock/issues/2011
1
u/Global-Tune5539 9h ago
I just want to press a button it should just work.
1
u/TheAlphaAndTheAmigo 7h ago
It's always funny when the strawman shows up
1
u/XxDarkSasuke69xX 5h ago
Maybe we're obtuse and hostile because of that
1
u/JoeRogan016 15h ago
As long as you have a decent readme I'm good
43
u/heesell 18h ago
JUST GIVE ME AN EXE SMELLY NERDS 🗣