[DOCS] Add getting started guide #3
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
and README_zh-CN.md
- contributing guide - code of conduct - issue templates
add model zoo
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Update the documentation in the code repository so that users and developers can easily get started and quickly master how to use it.
更新代码仓库中的文档，以便用户和开发者能够轻松上手并快速掌握使用方法。
Modification
Add or update the following document pages:
Update README.md and README_zh-CN.md
Add contribution guidelines, code of conduct, and issue templates.
Add a quick start guide and code map.
Additionally, update CMake utility functions in
util.cmake.添加或更新以下文档页面：
更新 README.md 和 README_zh-CN.md
添加贡献指南、行为准则和问题模板
添加快速入门指南与代码地图
此外，更新
util.cmake中的 CMake 实用函数。BC-breaking (Optional)
None.
Use cases (Optional)
None.
Checklist
Pre-commit or other linting tools are used to fix the potential lint issues.
The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like zetton-inference-tensorrt.
The documentation has been modified accordingly, like docstring or example tutorials.