README

概览

欢迎！ 《src-run/augustus-file-library》包提供了以下功能

一个扩展的SplFileInfo，包括额外的属性助手和临时文件自动删除。

分组

我们使用一个类似于Willy Wonka的命名规范为我们的包分组命名。本包属于augustus分组，这是一个以“核心反射基类”和相关功能为重点的包集合。

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

JTT

本包代表了一个在大量开源代码集合中的一个项目，这些代码在“SR”命名空间下发布，包括许多框架无关的库、一系列Symfony扩展包以及一些单独发布的版本。该项目由Rob Frawley 2nd 编写和维护。

• Rob Frawley 2nd
• 合作者

快速入门

安装

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

$ composer require src-run/augustus-file-library

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

require: {
	"src-run/augustus-file-library": "dev-master"
}

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

参考

API文档

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

计划为特定版本提供静态API参考，一旦本包成熟并达到版本1里程碑，将发布。.

上述API参考网站是使用一个可靠且功能完善的CLI工具Sami自动生成的。它经过严格和定期的测试，并用于一些大型项目，如Symfony全栈框架（见：https://src.run/go/symfony-api>），以及一些小型项目，如Twig（见：https://src.run/go/twig-api>）。请参考Sami的存储库页面以研究你在自己的项目中的使用。

示例/教程

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

贡献

讨论

对于一般咨询或讨论广泛的话题或想法，请在 Freenode 上查找“robfrawley”。他总是愿意讨论语言层面的想法、项目可能的新方向、新兴技术，甚至是天气。

问题

要报告问题或请求新功能，请使用项目问题跟踪器。在任何错误报告中都应尽可能提供详细信息。如果您在几天内没有收到回复，请随时“ping”该话题（有时 Github 通知电子邮件会丢失）。

代码

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

许可协议

本项目采用MIT 许可协议，这是一个 FSF 和 OSI 批准的、与 GPL 兼容的、宽松的自由软件许可协议。请参阅与源代码一起分发的LICENSE文件以获取更多信息。

其他链接