Table of Contents
Briefly describe what your tool does and its purpose.
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
- [![Next][Next.js]][Next-url]
- [![React][React.js]][React-url]
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.
Software or tools required before installation.
Make sure requirements.txt is up-to-date.
Step-by-step guide on how to install and set up the tool, incl. code blocks.
def welcome(tool-name):
print(f"Welcome to the {tool-name} GitHub page!")
welcome("cbe-webtool-name")Examples of how to run or use the tool, including commands and screenshots.
- For smaller tools without Documentation this Section is called
Usageand could contain a link to a local Markdown file with further explanations. - All larger tools should have a dedicated Documentation, ideally set up using GitBook and linked to the
docsfolder.
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". Thanks!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
The licensing information for the tool.
An overview of common licenses for open-source projects can be found here.
EXAMPLE
Distributed under the MIT License. See LICENSE.txt for more information.
Information on how to contact the tool maintainer(s). We tend to not provide detailed contact information, but to use GitHub Discussions instead.
Your Name - @your_linkedin - [email protected]
Project Link: https://github.com/benterich/CozieViz
Credits to those who have contributed to the tool or resources (e.g. libraries) that were helpful.
- Ben Gottfried Gottkehaskamp (AUTHOR)
Also a lot of inspiration is drawn from the Center for the Built Environment and its CBE Clima Tool Repository, created by: