Small readme cleanups #250
Conversation
- remove backwards incompatible changes section - add note about adding and running tests for devs - remove mention of incomplete man page - remove mention of force-pushed non-master branches
| @@ -1,6 +1,12 @@ | |||
| # Whipper | |||
|
|
|||
| [](https://github.com/JoeLametta/whipper/blob/master/LICENSE) [](https://travis-ci.org/JoeLametta/whipper) [](https://github.com/JoeLametta/whipper/releases/latest) [](https://webchat.freenode.net/?channels=%23whipper) [](https://github.com/JoeLametta/whipper/stargazers) [](https://github.com/JoeLametta/whipper/issues) [](https://github.com/JoeLametta/whipper/graphs/contributors) | |||
| [](https://github.com/JoeLametta/whipper/blob/master/LICENSE) | |||
There was a problem hiding this comment.
these render the same but are easier to read/edit in plaintext broken up like this into separate lines.
| @@ -126,8 +130,6 @@ is correct, while | |||
|
|
|||
| is not, because the `-d` argument applies to the `cd` command. | |||
|
|
|||
| ~~Check the man page (`whipper(1)`) for more information.~~ (currently not available as whipper's documentation is planned to be reworked ([Issue #73](https://github.com/JoeLametta/whipper/issues/73))). | |||
There was a problem hiding this comment.
We can add mention of a man page when we have one, but I don't think there's any need to call attention to the fact that it's a planned feature.
| Pull requests are welcome. | ||
|
|
||
| **WARNING:** As whipper is still under heavy development sometimes I will force push (`--force-with-lease`) to the non master branches. | ||
|
|
||
| ## Credits |
There was a problem hiding this comment.
I sort of want to delete this section, as it's easy to see in the git history who the developers are, and we already have all these names (+ Freso's now) in the copyright section.
|
I'd suggest to keep the ones in the README too. Many people don't get the git history when they're on their distro, but distros can often ship a README. Maybe the soon to be created manpage is another place for this? |
|
I think the copyright/license file is the right place to keep information about copyright holders and developers; at the bottom of the man page is definitely a relevant place for it though, at least by standard. I don't see many FOSS projects listing contributors in the README, which tends to be need-to-know-to-help-the-user information. |
|
It's particularly helpful if you want to find maintainers of software, though. And we should be doing this in each file (copyright header) too, with name and email addr. |
This reverts commit f2b126c.
|
I've restored the Credits section and resolved the conflicts with master. |
|
Merged, thanks. |
I think the only controversial thing here is the removal of the "backwards incompatible changes" section. As we grow into our own application, not merely a fork of morituri, I don't think it's useful to keep a manually updated list of changes in the README. The changelog / git history should suffice.