Add Project Readme with Markdown support #3680
Assignees
Labels
enhancement
New feature or request
Comments
nmanovic
changed the title
7 tasks
bsekachev
added a commit
that referenced
this issue
Jun 23, 2023
<!-- Raise an issue to propose your change (https://github.com/opencv/cvat/issues). It helps to avoid duplication of efforts from multiple independent contributors. Discuss your ideas with maintainers to be sure that changes will be approved and merged. Read the [Contribution guide](https://opencv.github.io/cvat/docs/contributing/). --> <!-- Provide a general summary of your changes in the Title above --> ### Motivation and context <img width="1130" alt="image" src="https://github.com/opencv/cvat/assets/40690378/3c1b767d-2aa2-474b-af1e-1fc02d8c359d"> <img width="1133" alt="image" src="https://github.com/opencv/cvat/assets/40690378/fdf6115a-e88d-4da6-83fb-c9fddd871e49"> <img width="1920" alt="image" src="https://github.com/opencv/cvat/assets/40690378/f6e97db5-84cb-4c1e-9b2a-82eca633a79c"> Resolved #287 Resolved #3680 Resolved #5580 ### How has this been tested? <!-- Please describe in detail how you tested your changes. Include details of your testing environment, and the tests you ran to see how your change affects other areas of the code, etc. --> ### Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. If an item isn't applicable for some reason, then ~~explicitly strikethrough~~ the whole line. If you don't do that, GitHub will show incorrect progress for the pull request. If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [x] I submit my changes into the `develop` branch - [x] I have added a description of my changes into the [CHANGELOG](https://github.com/opencv/cvat/blob/develop/CHANGELOG.md) file - [ ] I have updated the documentation accordingly - [ ] I have added tests to cover my changes - [x] I have linked related issues (see [GitHub docs]( https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)) - [x] I have increased versions of npm packages if it is necessary ([cvat-canvas](https://github.com/opencv/cvat/tree/develop/cvat-canvas#versioning), [cvat-core](https://github.com/opencv/cvat/tree/develop/cvat-core#versioning), [cvat-data](https://github.com/opencv/cvat/tree/develop/cvat-data#versioning) and [cvat-ui](https://github.com/opencv/cvat/tree/develop/cvat-ui#versioning)) ### License - [x] I submit _my code changes_ under the same [MIT License]( https://github.com/opencv/cvat/blob/develop/LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Current Situation
right now, the "Projects" tab is a wrapper around a certain number of tasks, grouping them into a single project.
Suggested Situation
I would like to be able to add a Markdown-README to a project that will be displayed on top of the project. That readme file could contain links to e.g. a github repository, where I place my scripts to preprocess the data or a priorisation of tasks to be done within this project, or even a set of edge-case images.
This could remove the need for a third party tool to manage labeling projects.
Thanks for considering this request.
The text was updated successfully, but these errors were encountered: