README

持续集成	代码质量审查	单元测试覆盖率

概述

欢迎！scr-be/mantle-bundle 包主要用于Scribe Inc的自身网站和客户网站。它包括了我们开发所需的所有包的集合。

分组

此包是 mantle 组的一部分（说明），该组由其他发布版本组成，专注于 框架基础 和相关功能。

JTT

此包代表了一个在 大量开源代码 集合中的一个项目，这些代码在 Scribe 命名空间下发布，包括无框架库和多个Symfony包。这些项目由 Rob Frawley 2nd 和 合作者 编写和维护，通常在 Scribe Inc 的支持下。

快速开始

安装

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

$ composer require scr-be/mantle-bundle

要启用此包，请通过在包数组中实例化 ScribeMantleBundle 来在您的Symfony应用程序内核中注册它。

// app/AppKernel.php
class AppKernel extends Kernel {
    public function registerBundles() {
        $bundles = [
            // ...
            new Scribe\MantleBundle\ScribeMantleBundle(),
        ];
        // ...
    }
}

配置

可以通过使用Symfony控制台命令 app/console（假设使用Symfony全栈框架和包注册）来引用可用的配置值。此外，此包提供了一个裸露的控制台可执行文件，可以通过调用以下内容来调用。

bin/mantle config:dump-reference scribe_mantle

参考

API文档

此包的API文档可在 scr.be/mantle-bundle/api 找到（以及在下方的 参考 徽章中通过 其他链接 标题链接）。所有API参考都是针对 master Git分支构建的，并在每次Git推送时自动更新——一旦此包成熟，将提供 特定版本 的API参考。

整个API参考网站是使用名为Sami的快速、可靠且功能完善的CLI工具自动生成的。Sami是一个Sami。它经过严格和定期的测试，包括在大型的、复杂的项目中使用，例如Symfony全栈框架（scr.be/go/api-ref-symfony>），以及在其小型项目中使用，例如Twig（scr.be/go/api-ref-twig>）。查阅Sami的GitHub页面以了解如何将其用于您自己的项目！

示例/教程

目前，除了这个README之外，没有其他“人工编写的”文档。待软件包稳定和资源可用后，将发布一个RTD（Read the Docs）页面，其中包含更多信息以及教程，包括在Symfony框架中的实际使用案例。

贡献

讨论

对于一般性咨询或讨论广泛的话题或想法，您可以在Freenode上找到robfrawley。还有一个#scribe频道，您可以通过以下链接加入irc.choopa.net:6669/scribe。

问题

要报告问题或请求新功能，请使用GitHub或GitLab开始讨论。尽可能提供详细信息，以帮助快速解决问题。如果您几天内没有收到回复，请随时“ping”该主题。

代码

您在使用此软件包时创建了额外的功能？将其发送到上游！不要犹豫提交拉取请求！除了在贡献指南中概述的简要要求之外，您的想象力是唯一的限制。

许可

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

附加链接

目的	状态
稳定版本
开发版本
许可
参考