rmlint
rmlint copied to clipboard
make install instructions a bit friendlier
Hi, This is a suggestion for clarification with install documentation. I lack the skills and background to create a more concrete edit than this. So I will put here and you can do with it whatever you please, or not.
-
change in readme.rst to specify Mac
It runs and compiles under most Unices, including Linux, FreeBSD and ~~Darwin~~ Mac OS.
I assume "Darwin" is synonymous with Mac OS; if there is some distinction, then change to be accurate but still mention Mac OS. Not everyone will recognize Darwin and if you are find-in-paging to see if OS is supported it is confusing.
-
change in readme.rst to specify binaries available and link. Right now it sounds like the only way to install is to compile. I'd suggest for example:
INSTALLATION
------------
Chances are that you might have `rmlint` already as readily made package in your
favourite distribution. If not, you have two choices:
1. download a pre-built binary [link to correct section in install doc]
2. `compile it from source <http://rmlint.readthedocs.org/en/latest/install.html>`_. [change link to compiling section]
- add heading to install.rst for binaries/packages
I am not a programer so not sure what the best way to organize the rest of the content of this page is, but right now the install instructions/links for pre-built packages are under Installation > Dependencies > Build dependencies which doesn't make sense.
The binaries should have an h2 level section which is either above or below the compiling stuff, rather than in the middle of it.
I think there is a kind of convention that shorter, simpler instructions should be at the top. Particularly, I think packages should go before "dependencies" because it makes me wonder if I need to have glib etc installed to run the package. (Yes I have made this kind of comprehension error before.)
That's it finally. Thank you for you attention. I apologize for not being able to more directly fix this, but I think I might have ended up making some kind of mess due to not understanding much of the content on the pages.
Hello @CouldBeThis,
I would appreciate the clarification you mentioned as a Pull Request. This would eliminate the possible back & forth when I'd do the changes. This way I can just review & merge your changes. Don't worry, creating pull requests is not too hard. :smile:
You can probably just use the "pen button" here. If I remember right, this would allow to create a PR using the Github UI alone.