README

Laravel 包，用于处理新的帕萨尔加德支付网关实现（2024）

此包旨在作为Laravel的包使用，以实现帕萨尔加德银行的新实现，因为之前的包无法与它兼容。

此仓库包含

1. 标准README规范。
2. 一个链接到一个你可以使用的检查器来保持你的README维护（正在进行中）。
3. 一个链接到一个你可以使用的生成器来创建标准README。
4. 徽章指向此规范。
5. 标准README示例 - 例如你正在阅读的此文件。

标准README是为开源库设计的。尽管它历史上是为Node和npm项目设计的，但它也适用于其他语言和包管理器中的库。

目录

• 背景
• 安装
• 使用
  • 生成器
• 徽章
• 示例README
• 相关努力
• 维护者
• 贡献
• 许可证

背景

标准README始于@maxogden在feross/standard提出的原始问题，关于是否需要一个工具来标准化README。大量讨论最终出现在zcei的standard-readme仓库中。在维护IPFS仓库时，我需要一个方法来标准化该组织中的Readmes。这个规范就是由此产生的。

当有人可以使用你的模块而不必查看其代码时，你的文档才是完整的。这非常重要。这使得你可以将你的模块的文档化接口与其内部实现（内容）分开。这是好的，因为这意味着只要接口保持不变，你可以自由地更改模块的内部。

记住：是文档，而不是代码，定义了模块的功能。

~ Ken Williams, Perl Hackers

编写README非常困难，而且保持其维护也很困难。通过卸载此过程 - 使编写更容易，使编辑更容易，使清楚或否一个编辑符合规范 - 你可以花更少的时间担心你的初始文档是否好，花更多的时间编写和使用代码。

通过有一个标准，用户可以花更少的时间寻找他们想要的信息。他们还可以构建工具来从描述中收集搜索词，自动运行示例代码，检查许可，等等。

此仓库的目标是

1. 一个定义良好的 规范。您可以在 规范文档 中找到它。它是一个持续改进的工作；请提出问题以讨论更改。
2. 一个示例 README。此 README 完全符合标准-readme，example-readmes 文件夹中还有更多示例。
3. 一个可以用来检查给定 README 中错误的 代码检查工具。请参阅 跟踪问题。
4. 一个可以用来快速构建新 README 的 生成器。请参阅 generator-standard-readme。
5. 为用户提供的 合规徽章。请参阅 徽章。

安装

本项目使用 composer 和 laravel。如果您没有在本地安装它们，请查看它们。

$ composer require upcoders/pep-payment

使用

这只是一个文档包。您可以将 spec.md 打印到您的控制台。

$ standard-readme-spec
# Prints out the standard-readme spec

生成器

要使用生成器，请参阅 generator-standard-readme。该包中有一个全局可执行文件，用于运行生成器，别名为 standard-readme。

徽章

如果您的 README 符合 Standard-Readme 且您在 GitHub 上，添加徽章会很好。这允许人们链接回此规范，并有助于 README 的采用。徽章是 非必需的。

要添加 Markdown 格式，请使用此代码

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

相关努力

• README 的艺术 - 💌 学习编写优质 README 的艺术。
• 开源模板 - 一个用于鼓励开源贡献的 README 模板。

维护者

@Upcoders.

如果您有任何问题或需要帮助实施此包，请随时通过 upcoders 联系我们。

贡献

请随意深入！打开问题 或提交 PR。

Standard Readme 遵循 贡献者守则。

贡献者

这个项目之所以存在，要归功于所有贡献者。

许可证

MIT © Upcoders.ir