-
Notifications
You must be signed in to change notification settings - Fork 120
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve README #85
Comments
I agreed, the README file needs to get improved for clarification on the methods and all things said above 👍. This will give current and future contributors a stepping stone to work off it. We may need a wiki page that explains how to integrate new method algorithms into the current code. Let me know your thoughts on this. Also, having a changelog file would be a great idea. |
@andrewhowdencom, changelog request merged. |
@ring0lab A wiki page would be neat-o. |
You can add legend for the flags, as example the -A flag thank you |
I don't mind it all that much. But I think it could be a little more "friendly".
There's also been a little bit of talk on twitter about it; and I think we should take some of that constructive criticism and do something about it.
I opened this issue to document it and have an open discussion about it to help fix up the README all pretty like.
Ideas
I'm hoping current contributors ( and future contributors 😉 ) will add what they'd like to see included or be improved upon.
Some stuff I thought about to get the ball roll'n
The text was updated successfully, but these errors were encountered: