重新组织 README 和 doc/

Question

我想重新组织 README，使其更易于用户查找所需信息。目前的 README 文件相当长，可能会导致信息过载。我目前的考虑是，新的 README 文件应尽可能简短，并根据用户对 test.check 的经验提供链接。我认为以下三个标题可能会有用

1. 新手。让我看看这是怎么回事。
   * 五分钟内展示几个酷炫的功能。也许可以在 examples/ 中包含一些示例测试。这样，新用户只需克隆存储库并在两分钟内运行一个测试即可。

2. 仍在入门阶段，让我看看一些教程和示例。

            *  This will probably build on the existing doc/intro.md file, which currently describes how to write generators.
   

3. 现有用户，让我看看 API 文档、发行说明和高级技术。

   • API 文档

          *  Release-notes, make it clear these are up-to-date, and have clear instructions when there are breaking changes
     

   • 高级技术/教程

Answer 1

评论者：gfredericks

请注意，其中一些内容可能应该包含在 clojure.org 的指南中。

Answer 2

参考： https://clojure.atlassian.net/browse/TCHECK-14 (reiddraper 报告)