README

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

概述

欢迎！scr-be/teavee-image-magic-bundle 包提供了一个简单的 IMagick 扩展抽象。

分组

此包是teavee组的一部分（说明），该组由其他发布的产品组成，主要关注于媒体、HTML、内容、生成器和相关功能。

JTT

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

快速开始

安装

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

$ composer require scr-be/teavee-image-magic-bundle

要启用此扩展包，请在 Symfony 应用程序内核中将 ScribeTeaveeImageMagicBundle 实例化到扩展数组中。

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

配置

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

bin/teavee-image-magic config:dump-reference scribe_teavee_image_magic

参考

API 文档

此包的 API 文档可在scr.be/teavee-image-magic-bundle/api找到（以及通过位于“附加链接”标题下的参考徽章下方的链接访问）。所有 API 参考均针对 master Git 分支构建，并在每次 Git 推送时自动更新——一旦此包成熟，将为 特定版本 提供API参考。

整个API参考网站是使用一个快速、可靠且功能完善的CLI工具自动生成的，这个工具叫做Sami。它经过严格和定期的测试，被用于大型、复杂的项目中，例如Symfony全栈框架 <参考：[scr.be/go/api-ref-symfony](https://scr.be/go/api-ref-symfony)>，以及小型项目如Twig <参考：[scr.be/go/api-ref-twig](https://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”该主题。

代码

在使用这个包的过程中，您添加了额外的功能？请将其发回上游！不要犹豫，提交一个pull请求！除了在贡献指南中概述的简要要求之外，您的想象力是唯一的限制。

许可

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

其他链接

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