Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Add comprehensive installation instructions #206
Converts the old INSTALL file to a markdown-formatted INSTALL.md file
The Installation section is complete for CentOS/RHEL, and has been
The Configuration sections is intended to walk through some common
This is a followup on this Reddit discussion from a few days ago. Let me know if there's anything that should be changed or otherwise cleaned up.
So, I like the work you did here, but I'm a little wishy-washy about taking it. Markdown is pretty on Github, but it's more of a PITA to parse on the command line, and I'm partial to the idea of being able to read the install docs with a simple
I would say that Markdown is appropriate for installation instructions because they include acquiring the software—something that you don't typically read up on in the terminal.
Aside from that, I do think it's generally appropriate for software to have markdown-formatted documentation for ease of reading when viewing things online, where less-pretty documentation and examples is for
This format is a good choice for making the software more accessible to the novice or enthusiast without seriously hampering or inconveniencing experienced professionals.
If you like/accept this PR, I would add a link to this document from the main readme, and submit another PR for that if you like. Consider opening an issue to see if anyone has suggestions for the configuration section of this document, or if that should be split into another file and documented there—it's very related but just out of scope for what I was working on.
I'm definitely okay with this as a separate document designed/intended to be read on Github and linked to from the main readme..
There is the issue of then needing potentially to maintain two different sets of instructions, but then again, it gives us the chance to take some baby steps and perhaps in the future look at who's using which more frequently.
@backamblock When I originally wrote this, I had to leave some parts either blank or unfilled because I didn't have enough information to finish it properly at the time, and had sort of hoped someone else might step in.
I'll carve out some time to spend an hour or two on it either this weekend or next, and will add the instructions necessary for use on Ubuntu/Debian as well.
@phreaker0 if you want to add me as a reviewer, I'll tag this PR with my review once I update it.