跳至内容

开始使用 PROJECTNAME

项目应该为用户提供一个入门指南。入门指南的目的是提高采用率并消除项目入门障碍。用户应该能够在大约五分钟内完成这些步骤。

项目的入门指南应该让用户快速获得第一个成功。一般来说,用户应该安装项目、快速验证安装,并运行一两个命令。项目入门指南中的命令应该执行一些基本操作,但应说明项目的核心功能。如果适用,请考虑提供允许用户在本地运行代码的示例配置值和工件。

以下步骤旨在提供一个带有名为“ansible-project”的示例项目的合理入门指南思路。

  1. 安装 ansible-project

bash pip install ansible-project

  1. 检查安装。

bash ansible-project --version

  1. 运行演示基本功能的命令。

bash ansible-project automate --target=user_success

  1. 验证命令是否成功。

现在您已完成使用 ansible-project 的第一个任务!

添加一些指向用户应作为后续步骤参考的资料的链接。鼓励用户继续学习并使用项目学习新技能。