search

joelpurra / npshell

Command line music queue manager. A music player from the comfort of your own shell.
https://joelpurra.com/projects/npshell/
GNU General Public License v3.0
15 stars 0 forks source link

Add man page #4

Open joelpurra opened 9 years ago

joelpurra commented 9 years ago

Feature suggested by @RobertAudi in #3.

Added a man np page generated from USAGE.md in 7c3e20e906f2e2f80b7df3100f81d88755dedeba. It should be installed by package managers, such as brew install np in joelpurra/homebrew-joelpurra#1.

RobertAudi commented 9 years ago

This looks good (apart from this).

Also, I think a Contributing section should be added to the README to list the development dependencies (among other things). Potential contributors would be cought by surprise if they realize at the last moment that they need to install stuff in order to commit code.

On that note, I am starting to question the git hook decision. It might be a good reason NOT to contribute for some people.

joelpurra commented 9 years ago

@RobertAudi wrote:

Also, I think a Contributing section should be added to the README to list the development dependencies (among other things). Potential contributors would be cought by surprise if they realize at the last moment that they need to install stuff in order to commit code.

I'd rather keep it in the separate CONTRIBUTE.md file and a contribution section in the readme shouldn't do anything but point to it. This way there's no question that there's a single place for devs to look, and other tips can be added without making README.md long and less easy to read (which is important for newcomers). Not everyone is a dev, which is why I created a separate file when the TODO became too long (although I could/should also use issues for each suggested improvement/group to encourage discussions). I'm also thinking of moving manual installation to a separate file -- prefer to only promote package systems (although there's only brew atm).

On that note, I am starting to question the git hook decision. It might be a good reason NOT to contribute for some people.

True. It currently looks like you're forced to install md2man-roff for any kind of development. Could be mentioned that it isn't actually a requirement for non-usage altering patches, and that I could actually run the tool for them.

Is there an alternative solution? Having a Makefile would imply that compilation is required for usage, which it isn't. Having a separate update-man-page.sh command might work, as long as it's documented.

joelpurra commented 9 years ago

Oh, and I forgot to refactor the folder structure before pushing the commit. I don't think it's great at the moment, but couldn't think of an obvious place for the git hook (which isn't really source, but part of the dev stuff -- or build stuff, perhaps) as well as the generated man page (which isn't source either, but documentation -- except it's auto-generated). Suggestions (for example pull requests) are most welcome!