Project Title

Title optional if using header logo and badges

---

---

Project description goes here. Try to keep it one paragraph or less.

This template repository is intended for open source project use. In its current state, its purpose is to provide a quick way to get your project and community started using a limited set of tools, and offer some alternatives or additional options where appropriate.

As such, feel free to modify it as you see fit. You don't have to give attribution, but you can if you want to.

Table of Contents

• Optional but Helpful
  • Badges
  • Visuals
• Getting Started
  • Prerequisites
  • Installing
• Running the Tests
  • End to End Tests
  • Coding Style Tests
• Deployment
• Built with
• Versioning
• Roadmap
  • Readme TODOs
• Support & Community
• Contributing
• Team
• Acknowledgments
  • Resources
• Legal
  • Metrics/Analytics
  • License

Optional but Helpful

The following features might not be ready at the beginning of development, but are nevertheless helpful for users.

Badges

Badges can be included here if you don't want them listed in the heading under a logo graphic.

• https://github.com/badges/shields
• Badges can be created at https://shields.io/

Visuals

Screencasts, screenshots, etc. consider using:

• https://asciinema.org/
• https://github.com/icholy/ttygif

Back to ToC

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

# Give the example

And repeat

# until finished

End with an example of getting some data out of the system or using it for a little demo

Back to ToC

Running the Tests

Explain how to run the automated tests for this system

End to End Tests

Explain what these tests test and why

Give an example

Coding Style Tests

Explain what these tests test and why

Give an example

Back to ToC

Deployment/Packaging

Add additional notes about how to deploy this on a live system

• Web

  • Server config

    • Security groups, Ports, DNS

  • Pulling your repo

    # list any commands

  • Launch tools like

    • docker, capistrano, chef, jenkins, etc.
    • Continuous Integration

    # necessary for each step

  • Production Services

    • Caching (memcached, redis, etc.)
    • Process Management (PM2, systemd, Docker restart policy)
    • DBs, Message Queueing, any other service your app

• Local - list steps as above

Back to ToC

Built With

• List
• Dependencies
• and Tools
• Here

Back to ToC

Versioning

This project uses SemVer for versioning. For the versions available, see the tags on this repository or in CHANGELOG.md.

Back to ToC

Roadmap

• list upcoming
• features and
• tasks here

Full list of forthcoming features and changes can be found on our Roadmap.

README TODOs

• look into and possibly add analytics
• look into tools for spreading awareness
  • https://hacks.mozilla.org/2013/05/how-to-spread-the-word-about-your-code/
  • https://mozillascience.github.io/working-open-workshop/personas_pathways/
  • https://opensource.guide/finding-users/
  • https://opensource.guide/building-community/
  • https://www.producthunt.com/
• Consider adding logo/badges/etc. above the title
  • Remove description heading - Decided to keep
• Add table of contents
  • Link sections using anchor/name
  • Deploy section needs more detail
• Look into CI

Back to ToC

Support and Community

Help can be sought by visiting:

• github.com/my/project/issues
• readthedocs.org
• discordapp.com/channels/###

Back to ToC

Contributing

Please read CONTRIBUTING.md for how to help with project tasks and the process for submitting pull requests to us.

Please note that this project is released with a Contributor Code of Conduct viewable at CODE_OF_CONDUCT.md. By participating in this project you agree to abide by its terms.

Back to ToC

Team

Author(s), Core Team, Maintainers, Contributers, Committers, etcetera

• Sarandos Klikizos - Author, Initial work - sarandi
• List Others
• Here Along with
• Title etcetera

See also the list of contributors who participated in this project.

Back to ToC

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc

Resources

This document is a bricolage of numerous ideas gleaned mostly from open source projects:

1. Open Source Guide
2. https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md
3. https://docs.readthedocs.io/en/stable/contribute.html
4. https://www.writethedocs.org/guide/
5. https://github.com/kylelobo/The-Documentation-Compendium
6. https://github.com/jamiebuilds/documentation-handbook
7. https://dev.to/kefranabg/generate-beautiful-readme-in-10-seconds-38i2?

Feedback on your README and other repo features can be sought here:

1. https://github.com/LappleApple/feedmereadmes
2. https://maintainer.io/

Thank you to the people and communities who have built these resources.

Back to ToC

Legal

Metrics/Analytics

This project USES XXX/DOES NOT USE software to collect anonymous information about users and their use patterns.

License

This project is licensed under the MIT License - see the LICENSE file for details