README

概述

欢迎！ src-run/vermicious-console-io-library 包提供以下功能

增强型控制台输入/输出样式实现，具有完整的面向对象API。

分组

我们使用灵感来自Willy Wonka的命名规范来命名我们的包分组名称。此包是augustus分组的一部分，这是一个专注于“核心反射基类”和相关功能的包集合。

如果您手头上有太多时间，欢迎研究一些关于这个特定组无用的细节。

JTT

此包代表一个在大量开源代码集合中的单个项目，这些代码在“SR”命名空间下发布，包括许多框架无关的库、一组Symfony捆绑包以及一些独立发布。该项目由以下人员编写和维护：

• Rob Frawley 2nd
• 合作者

快速入门

安装

通过使用Composer CLI显式要求代码，或者通过编辑您的composer.json文件以反映依赖关系并更新项目需求来获取代码。例如，要使用CLI显式要求此项目，请使用以下命令。

$ composer require src-run/vermicious-console-io-library

或者，要将此项目添加到您的“composer.json”文件中，请将以下内容添加到“require”部分。

require: {
	"src-run/vermicious-console-io-library": "dev-master"
}

注意：不建议使用“dev-master”约束。请意识到这样做可能会允许拉入具有向后不兼容的、破坏性更改的版本。相反，使用语义版本控制并显式指定要求是良好的实践。例如，要要求版本1.0，请使用^1.0。

参考

API文档

此包的API参考可在我们的文档网站上找到（请参阅以下“附加链接”部分中找到的表格的“参考”行）。所有API文档都会在git push事件发生时自动编译针对master分支。

特定版本的静态API参考计划中，将在本包成熟并达到版本1里程碑时发布。.

上述API参考网站是使用一个可靠且经过良好开发的CLI工具Sami自动生成的。它经过严格和定期的测试，并被用于一些大型项目，例如Symfony全栈框架 <see: https://src.run/go/symfony-api>，以及一些小型项目，例如Twig <see: https://src.run/go/twig-api>。请参考Sami的仓库页面以研究在您的项目中使用Sami。

示例/教程

目前，除了本README之外（它本身也是从模板生成的），没有“人工编写的”文档。待包稳定、可用的人时和外部用户实际需求后，我们可能会发布一个带有官方文档、教程和额外资源的Read the Docs页面。

贡献

讨论

对于一般咨询或讨论广泛的话题或想法，请在Freenode上寻找“robfrawley”。他总是愿意讨论语言级别的想法、项目可能的新的发展方向、新兴技术，以及天气。

问题

要报告问题或请求新功能，请使用项目问题跟踪器。在任何错误报告中尽可能提供更多信息。如果您几天内没有收到回复，请“ping”该主题（有时GitHub通知电子邮件会掉入裂缝）。

代码

在利用这个包的同时，您创建了额外的功能？太棒了：把它发送回上游！不要犹豫提交拉取请求！您的想象力和我们在CONTRIBUTING.md文件中概述的要求是唯一的限制。

许可证

本项目的许可证为MIT许可证，这是一个FSF和OSI批准的、与GPL兼容的、宽容的免费软件许可证。有关更多信息，请查看与源代码一起分发的LICENSE文件。

其他链接