brimstone / brimstone.github.io

My user page

https://brimstone.github.io

0 stars 1 forks source link

Make a README.md linter #13

Open brimstone opened 5 years ago

brimstone commented 5 years ago

Standard-readme seems simple enough to implement. I need to get all of my projects cleaned up. A clean, high quality readme would help.

https://github.com/RichardLitt/standard-readme/issues/5

brimstone commented 5 years ago

Stealing from @jasnow's suggestions:

NETKOTH README.MD

Description

Scoring Engine for NetKotH where KotH stands for King of the Hill.

More information at: https://netkoth.github.io

<< TBD: This README would normally document whatever steps are necessary to get the application up and running. >>

Set up/Deploying as Admin for an Event

<< TBD: Deployment instructions >>

Requirements/Prerequisites

<< TBD: Technology Stack(s) >>
<< MAYBE/TBD: Linux OS >>
Go
Docker
<< TBD: System dependencies >>
<< TBD: Configuration >>

Contributing as Admin

Fork the project.
Make your feature addition or bug fix.
Add tests for it. This is important so I don't break it in a future version unintentionally.
Send a pull request. Bonus points for topic branches.

Virtual Machine Information

<< TBD: VM Info >>

TODOs/Problems

<< TBD: List of Known TODOs/Problems >>

DISCUSSION

If you have questions, please use this TBD.

CREDITS

Brimstone (https://github.com/brimstone)

License

This repo is released under the TBD-License.