重新组织 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 报告)