跳至内容

用户指南

欢迎使用 PROJECTNAME 用户指南!

如果您的项目不需要文档站点(例如,如果使用起来非常简单),则以下信息应出现在您的项目 README 中,如README 模板所示。

在以下部分中,如果内容像几行一样简单,请将其放在那里,否则创建单独的文件并从部分中引用它们。

沟通

需要帮助或想分享反馈?请参阅社区指南

入门

在此处描述如何入门,或参考单独的入门指南

安装

在此处描述流行平台的可能安装选项,或参考单独的安装指南

下一节

根据需要添加尽可能多的部分以涵盖所有使用方面。

还建议使用操作指南涵盖常见用例,并在此处列出它们。