Repository cleanup: README, CONTRIBUTING
We need to clean up and improve the overall structure and documentation of this repository to ensure consistency, clarity, and ease of use for contributors and users.
Tasks:
- Review and update
README.md
with clear purpose, setup instructions, and usage examples - Create a
CONTRIBUTING.md
with contribution guidelines, coding standards, and pull request process - Ensure presence of a
LICENSE
file and verify its accuracy - Restructure the
/documentation
folder (if present) for better navigation and readability - Ensure consistent formatting and naming across documentation files
- Check and update badges (build status, license, etc.) in
README.md
- Archive or remove outdated or deprecated documentation files
Goal:
Improve onboarding, encourage contributions, and ensure high-quality project documentation.
Edited by Jens Leveling