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参考网站是通过名为Sami的快速、可靠且功能完善的CLI工具自动生成的。Sami的GitHub页面可在此处找到：Sami。它通过在大型、复杂的项目中使用进行严格和定期的测试，例如在Symfony全栈框架中，以及在其scr.be/go/api-ref-symfony>和Twig中的使用进行了测试。<see: 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 request！除了在贡献指南中概述的简要要求外，您的想象力是唯一的限制。

许可

本项目采用MIT许可证授权，这是一个FSF-/OSI-批准的并与GPL兼容的宽松免费软件许可证。有关更多信息，请查看与源代码一同分发的LICENSE文件。

其他链接

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