Customize this file after creating the new REPO and remove this lines.
What to adjust:
- Add the your project or repo name direct under the logo.
- Add a short and long desciption.
- Add links for your final repo to report a bug or request a feature.
- Add list of used technologies.
- If you have, add a roadmap or remove this section.
- Fill up the section for set up and documentation.
- Start in this file only with documentation and link to the docs folder.
- Add more project shields. Use shields.io with style
for-the-badge.
------- end to remove -------
repo or project name
Add a description from your project here.
Built With
The documentation project is built with technologies we use in our projects:
- write here the list of used technologies
Roadmap
if you have a ROADMAP for your project add this here
See the open issues for a full list of proposed features (and known issues).
Set up
how can i start and fly this project
Documentation
what insights do you have to tell
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;use diagrams.
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 open an issue with the tag "enhancement", 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!
- Open an issue with the tag "enhancement"
- 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
More about this in the CODE_OF_CONDUCT file.
License
Distributed under the MIT License. See LICENSE file for more information.
Contact
it@M - opensource@muenchen.de