README

此项目为使用Keep A Changelog提供工具支持。

安装

运行以下命令安装此库

$ composer require phly/keep-a-changelog

或者，全局安装，以用于任何存储库

$ composer global require phly/keep-a-changelog

如果您全局安装，请确保将全局composer供应商二进制目录添加到您的$PATH环境变量中。您可以使用以下命令获取其位置

$ composer global config bin-dir --absolute

您可以将以下行添加到您的shell配置文件中，以便自动添加到您的PATH

export PATH=$(composer global config bin-dir --absolute):$PATH

按这种方式设置后，您可以使用keep-a-changelog而不是./vendor/bin/keep-a-changelog。

自2.3.0版本以来，我们提供独立的PHAR二进制文件。这些文件在每个发布版本的下载部分中可用。要获取最新版本，您始终可以使用以下URL

使文件可执行（例如，chmod 755 keep-a-changelog.phar），将其放置在您的$PATH中，并可选地移除.phar后缀

截至写作时，PHAR分发版尚不具备自我更新或检查更新的功能。

调用将通过以下之一进行

如果您在项目中通过Composer安装：./vendor/bin/keep-a-changelog
如果您通过Composer全局安装，并且已将Composer脚本路径添加到您的$PATH： keep-a-changelog。
如果您已下载PHAR文件并将其放置在您的$PATH中：可以是keep-a-changelog.phar，或者如果您已移除了.phar文件扩展名，则可以是keep-a-changelog。

从此处开始，我们将使用keep-a-changelog来调用命令；根据您的安装情况，替换适当的命令调用。

您可以通过运行以下命令来获取命令列表

$ keep-a-changelog

从那里，您可以使用以下命令获取单个命令的帮助

$ keep-a-changelog help <command>

有关更多信息，请访问文档。