README

概述

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

一个简单的存储对象抽象层，带有本地文件系统提供者实现。

分组

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

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

JTT

这个包代表了一个在大量开源代码集合中的一个项目，这些代码在 "SR" 命名空间下发布，包括许多框架无关的库、一系列的 Symfony 扩展包以及一些单次发布。该项目由以下人员编写和维护：

• Rob Frawley 2nd
• 合作者

快速入门

安装

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

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

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

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

注意：不推荐使用 "dev-master" 约束。请意识到这样做可能会允许引入向后不兼容、破坏性的更改。相反，使用语义版本化和明确要求是良好的实践。例如，要要求版本 1.0，你将使用 ^1.0。

参考

API 文档

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

计划为特定版本提供静态 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文件。

附加链接