Skip to content
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

Make a README.md linter #13

Open
brimstone opened this issue Sep 21, 2018 · 1 comment
Open

Make a README.md linter #13

brimstone opened this issue Sep 21, 2018 · 1 comment

Comments

@brimstone
Copy link
Owner

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

RichardLitt/standard-readme#5

@brimstone
Copy link
Owner Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant