在Android应用程序的项目树中放置开发人员文档的位置？

Question

我开发了一个Android应用程序。

除了源文件中的注释之外，我还编写了路线图类型文档，旨在帮助其他开发人员了解整个应用程序的结构。

我的问题： 在项目树中放置文档文件的位置，以便开发人员可以复制项目树，但是没有打包到安装APK文件中？

Answer 1

常见的做法是包含一个包含高级文档的顶级README或README.md（降价）。该文件放在项目根目录中。

许多项目托管服务提供商（如GitHub）在网站上查看项目时会呈现此README文件。

有关详细文档，请继续使用内联javadoc。