我想查看您的自述文件

我想帮助别人做出更好的自由和开源软件，所以我正在制作这个常设优惠：我会免费查看您的自述文件。

您有一个免费和开源的项目，并希望其自述人士更好。它可能是您的第一个项目，否则您可能需要局外人的反馈。我是一个局外人。我已经使用免费和开源软件工作了几十年，作为一种爱好和职业，所以我有一些阅读和写入自述文件的经验。

您在[email protected]发送给我的电子邮件至自述文件的链接，并要求我审查它。

我通过回复您的电子邮件向您发送反馈意见。如果我没有时间，我会回答这一点。无论哪种方式，我会在一周内回复。

你可以接受我的反馈或离开它。你没有必要只是因为互联网上的随机陌生人有意见。

如果你做了改变，我也可以看待那些，如果你想让我。

你可以在公共场合谢谢我，或者不喜欢。我不是为了名望而这样做。

不要告诉我关于你的项目的任何其他事情。 部分审查过程是看到自述文件是否独立。 我愿意每一个项目花一个小时。 我选择哪些项目工作和数量有多少项目。 这是我的空闲时间，我决定。 我不是校验者。 您可以使用拼写检查软件。 最多，我提供了一种复制编辑形式。 只需了解我理解的语言即可写入。 目前这是英语，芬兰语或瑞典语。 您的项目必须在公共版本控制存储库中。 我不在乎：Github，Gitlab，你跑自己的东西，无论如何。 我不在乎它是什么版本控制系统。 我将通过Web链接读取到自述文件的源。 您的项目必须由开源计划列为开源的许可证涵盖：https://opensource.org/licenses。 我确实有强烈的意见应该是什么样的东西。 我希望以下清单随着时间的推移而发展：

自述文件是为了一个首次遇到项目能够快速决定他们是否想要了解更多信息的人。 一个自述人员应该有一个“模糊”：一个非常简短的，旨在瞄准一个对其的人的项目尚未了解，并且可能不知道主题区域。 README不是手册，但它可能有一个例子如何通常使用该软件，特别是如果有助于读者更好地了解软件。 自述人员应该说权和其他法律方面如何影响项目。 它应该说项目使用的版权许可。 README还可以包含用于安装软件的说明，或者如何运行其测试套件以及其他实际方面，但也可以进入其他文档。 参考它们是好的，与项目的更多信息链接，以及谁在软件上工作。