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