royhills / ike-scan

The IKE Scanner
GNU General Public License v3.0
361 stars 59 forks source link

Create separate Markdown files for various sections of readme that require more detail #8

Open claudijd opened 10 years ago

claudijd commented 10 years ago

Since we now have markdown, which supports file linking, we could (if we wanted to) segment more of the complicated section of the REAMME.md into separate files with more detail.

One file I'd suggest in the onset would be a "CONTRIBUTING.md" file. This basically gives people the rules of the road for contributing to the project such as where to send bugs/feature requests, how to submit VID/Backoff fingerprints, etc.

Here's an example of one from another ruby project I have that I build from another smarter person than I about how to setup a solid CONTRIBUTING file.

Check it out, I'd like your feedback before pushing forward on this.

https://github.com/claudijd/c7decrypt/blob/master/CONTRIBUTING.md