通过以下方式搜索 
samwilson / console-readme-generator
用于添加命令文档的工具
0.3.3
2024-05-04 16:24 UTC
Requires
- symfony/console: ^5|^6|^7
Requires (Dev)
- mediawiki/minus-x: ^1.1
- phan/phan: ^5.0
- php-parallel-lint/php-parallel-lint: ^1.0
- phpunit/phpunit: ^8|^9|^10|^11
- roslov/psr12ext: ^11
- symfony/var-dumper: ^4|^5|^6|^7
README
一个小工具，用于将 Symfony Console 命令文档添加到项目的 Readme 文件中。
配置
- 在您的 Readme 中添加一个
## 使用标题（此部分的名称可以配置；请见下文）。 - 将
generate-readme命令添加到您的应用程序中，例如在./bin/console$application->add(new \Samwilson\ConsoleReadmeGenerator\Command\ReadmeGenCommand());
- 运行命令，例如
./bin/console generate-readme。
这将修改您的 README.md 文件。下面的使用文档是输出示例。
使用
generate-readme
为 Readme 文件生成命令文档。
generate-readme [-i|--include INCLUDE] [-r|--readme README] [-u|--usage USAGE]
--include-i— 明确包含一个命令（例如 "app:foo"）或命名空间（例如 "app:" 结尾带有冒号）。此选项可以多次提供。--readme-r— 要修改的 README 文件的路径（包括文件名）。默认：'[当前工作目录]/README.md'--usage-u— 要在其中插入文档的 README 文件中的部分名称。默认：'使用'
许可证：MIT
版权所有 © 2021 Sam Wilson。
特此授予任何获取本软件及其相关文档文件（"软件"）副本的任何人，免费使用软件的权利，不受任何限制，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利，并允许软件提供者使用软件进行此类操作，前提是遵守以下条件
上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。
软件按“原样”提供，不提供任何形式的保证，明示或暗示，包括但不限于适销性、适用于特定目的和无侵犯性的保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任负责，无论此类责任是基于合同、侵权或其他原因，无论此类责任是否源于、源自或与软件或软件的使用或其他方式有关。