https://github.com/centerforthebuiltenvironment/cbe-tool-template
Template for CBE Tool GitHub repos, including information to achieve consistent READMEs, front-end designs, and more.
https://github.com/centerforthebuiltenvironment/cbe-tool-template
Last synced: 2 months ago
JSON representation
Template for CBE Tool GitHub repos, including information to achieve consistent READMEs, front-end designs, and more.
- Host: GitHub
- URL: https://github.com/centerforthebuiltenvironment/cbe-tool-template
- Owner: CenterForTheBuiltEnvironment
- Created: 2024-06-25T16:47:25.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-15T14:41:28.000Z (about 1 year ago)
- Last Synced: 2025-09-09T23:56:33.945Z (9 months ago)
- Language: CSS
- Homepage:
- Size: 1.93 MB
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
CBE Tool README Template
- Short tool description -
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About the Tool
[](link-to-your-banner-image)
Briefly describe what your tool does and its purpose.
### Built With
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]
## 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
Software or tools required before installation.
Make sure `requirements.txt` is up-to-date.
### Installation
Step-by-step guide on how to install and set up the tool, incl. code blocks.
```python
def welcome(tool-name):
print(f"Welcome to the {tool-name} GitHub page!")
welcome("cbe-webtool-name")
```
## Usage OR Documentation
Examples of how to run or use the tool, including commands and screenshots.
- For smaller tools without Documentation this Section is called `Usage` and 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 `docs` folder.
## Roadmap
List any planned features or improvements.
_EXAMPLE_
- [x] Add Changelog
- [x] Add back to top links
- [ ] Add Additional Templates w/ Examples
- [ ] Add "components" document to easily copy & paste sections of the readme
- [ ] Multi-language Support
- [ ] Chinese
- [ ] Spanish
See open [issues](https://github.com/your-username/your-repo/issues) for a full list of proposed features (and known issues).
## 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".
Thanks!
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
## License
The licensing information for the tool.
An overview of common licenses for open-source projects can be found [here](https://choosealicense.com/licenses/).
_EXAMPLE_
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
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](https://linkedin.com/your_username) - email@example.com
Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)
## Acknowledgements
Credits to those who have contributed to the tool or resources (e.g. libraries) that were helpful.