TBD
Project description
GraphML
TBD
Getting Started • Features & Screenshots • Documentation • Support • Report a Bug • FAQ • Known Issues • Contribution • Changelog
Every project should contain a short description here to help users understand what it does. This description should cover a maximum of 4 lines. If there is a UI, you can also put a screenshot under this description.
Highlights
- 📄 README template with predefined structure.
- 🗃 Labeling and issue organization system.
- 📝 Contribution guideline template.
Getting Started
This section should contain the simplest and most basic way to run and use the project, preferably with one command.
Support & Feedback
This project is maintained by Benjamin Räthlein, Lukas Masuch, and Jan Kalkan. Please understand that we won't be able to provide individual support via email. We also believe that help is much more valuable if it's shared publicly so that more people can benefit from it.
Type | Channel |
---|---|
🚨 Bug Reports | |
🎁 Feature Requests | |
👩💻 Usage Questions | tbd |
📢 Announcements | tbd |
❓ Other Requests |
Features
Use this section for advertising the most important features and advantages of the project. Also, add screenshots or examples to showcase important features. The main purpose of this section is marketing.
Documentation
Either put the documentation here or use a deployed documentation site via mkdocs and link to the documentation.
Please refer to our documentation for information about deployment or usage.
FAQ
This is the example description of an faq item (click to expand...)
Known Issues
This is the example description of a known issue (click to expand...)
Contributors
TODO: sourcerer hall of fame is deprecated, find something different?
Contribution
- Pull requests are encouraged and always welcome. Read our contribution guidelines and check out help-wanted issues.
- Submit Github issues for any feature request and enhancement, bugs, or documentation problems.
- By participating in this project, you agree to abide by its Code of Conduct.
- The development section below contains information on how to build and test the project after you have implemented some changes.
Development
Requirements: Docker and Act are required to be installed on your machine to execute the containerized build process.
To simplify the process of building this project from scratch, we provide build-scripts - based on universal-build - that run all necessary steps (build, check, test, and release) within a containerized environment. To build and test your changes, execute the following command in the project root folder:
act -b -j build
Refer to our contribution guides for more detailed information on our build scripts and development process.
Licensed MIT. Created and maintained with ❤️ by developers from Berlin.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.