diff --git a/README.md b/README.md index 8217dde158..f5c8ea81a1 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,57 @@ ## OpenCV: Open Source Computer Vision Library +Welcome to OpenCV, an open-source library for computer vision and machine learning. This README will guide you through essential resources, community guidelines, and contribution instructions. -### Resources +### Getting Started -* Homepage: - * Courses: -* Docs: -* Q&A forum: - * previous forum (read only): -* Issue tracking: -* Additional OpenCV functionality: -* Donate to OpenCV: +- **Homepage**: [opencv.org](https://opencv.org) + Explore a wide range of OpenCV functionalities, tutorials, and updates. +- **Documentation**: [OpenCV Docs](https://docs.opencv.org/4.x/) + Detailed documentation for developers across multiple languages. +- **Courses**: [OpenCV Courses](https://opencv.org/courses) + Enhance your understanding with free and paid courses. +- **Q&A Forum**: + - Active discussions: [forum.opencv.org](https://forum.opencv.org) + - Read-only archive: [answers.opencv.org](http://answers.opencv.org) +- **Issue Tracking**: [GitHub Issues](https://github.com/opencv/opencv/issues) + Track and report issues, suggest features, or contribute fixes. +- **Extended Functionality**: [OpenCV Contrib](https://github.com/opencv/opencv_contrib) + Explore additional modules for even more computer vision tools. +### Community Resources -### Contributing +- **Submit Your Project**: [Community Project Submission](https://form.jotform.com/233105358823151) + Feature your OpenCV project in Community Friday on the official website. +- **YouTube Channel**: [OpenCV on YouTube](http://youtube.com/@opencvofficial) + Subscribe for tutorials, live streams, and project showcases. +- **Follow OpenCV**: + - [LinkedIn](http://linkedin.com/company/opencv) + - [Mastodon](http://mastodon.social/@opencv) + - [Twitter](https://twitter.com/opencvlive) -Please read the [contribution guidelines](https://github.com/opencv/opencv/wiki/How_to_contribute) before starting work on a pull request. +Want to volunteer? [Apply Here](https://form.jotform.com/232745316792159) to help organize events and amplify our online presence. -#### Summary of the guidelines: +### Contributing to OpenCV -* One pull request per issue; -* Choose the right base branch; -* Include tests and documentation; -* Clean up "oops" commits before submitting; -* Follow the [coding style guide](https://github.com/opencv/opencv/wiki/Coding_Style_Guide). +We appreciate contributions from the community! Before you get started, please review our [contribution guidelines](https://github.com/opencv/opencv/wiki/How_to_contribute). + +#### Key Contribution Guidelines + +- **Pull Requests**: + - One pull request per issue. + - Select the correct base branch. +- **Tests & Documentation**: + Ensure all changes are accompanied by relevant tests and documentation updates. +- **Clean Commit History**: + Clean up any unnecessary commits before submitting your pull request. +- **Coding Standards**: + Follow the [OpenCV Coding Style Guide](https://github.com/opencv/opencv/wiki/Coding_Style_Guide). ### Additional Resources -* [Submit your OpenCV-based project](https://form.jotform.com/233105358823151) for inclusion in Community Friday on opencv.org -* [Subscribe to the OpenCV YouTube Channel](http://youtube.com/@opencvofficial) featuring OpenCV Live, an hour-long streaming show -* [Follow OpenCV on LinkedIn](http://linkedin.com/company/opencv/) for daily posts showing the state-of-the-art in computer vision & AI -* [Apply to be an OpenCV Volunteer](https://form.jotform.com/232745316792159) to help organize events and online campaigns as well as amplify them -* [Follow OpenCV on Mastodon](http://mastodon.social/@opencv) in the Fediverse -* [Follow OpenCV on Twitter](https://twitter.com/opencvlive) -* [OpenCV.ai](https://opencv.ai): Computer Vision and AI development services from the OpenCV team. +- [OpenCV.ai](https://opencv.ai): + Professional computer vision and AI services from the OpenCV team. +- [Support OpenCV](https://opencv.org/support/): + Donate to help maintain and grow the OpenCV community. + +We encourage new users to dive into the community, ask questions, and start contributing. For more detailed information, visit our [GitHub repository](https://github.com/opencv/opencv).