Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements to readme.md file content #750

Closed
RuoChengF opened this issue May 4, 2023 · 0 comments
Closed

Improvements to readme.md file content #750

RuoChengF opened this issue May 4, 2023 · 0 comments
Labels
kind/bug Something isn't working

Comments

@RuoChengF
Copy link

As for the README.md file, the code structure directory of the project is not shown in either Chinese or English, which is not very friendly. I hope that a code structure directory can be provided, and then the main role of each file or main file can be marked and so on.
关于README.md 文件中不管是中文还是英文,均没有展示项目的代码结构目录 ,这点不是很友好 , 希望可以提供一个代码结构目录 ,然后可以进行标注每个文件或主要文件的主要作用等等 .

The second requirement is about environmental dependence, which is not reflected in the README.md file, so it is not very friendly and I hope it can be improved

第二点的需求是关于 环境依赖这部分在README.md 文件中也没有体现,不是很友好希望可以改进

@RuoChengF RuoChengF added the kind/bug Something isn't working label May 4, 2023
@qmhu qmhu closed this as completed May 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants