Skip to content

Latest commit

 

History

History
177 lines (131 loc) · 5.75 KB

TEMPLATE_README.md

File metadata and controls

177 lines (131 loc) · 5.75 KB

::project_title

Version: ::semver_version

Contributors Forks Stargazers Issues ::license_name

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About the Project

::{Describe the project.}

Built With

::{Example-1} ::{Example-2}

(back to top)

Getting Started

::{This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.}

Prerequisites

::{This is an example of how to list things you need to use the software and how to install them.}

  • ::{Make sure ASDF is installed}

Installation

  1. ::{installation instructions}

(back to top)

Usage

::{Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.}

::{For more examples, please refer to the Documentation}

(back to top)

Roadmap

  • ::{Feature 1}
  • ::{Feature 2}
  • ::{Feature 3}
    • ::{Nested Feature}

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

::{Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.}

::{If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!}

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the ::license_name. See LICENSE.txt for more information.

(back to top)

Contact

::{Your Name - [email protected]}

(back to top)

Acknowledgments

(back to top)