If I see two README files in a project, I would get confused. Conventions are usually that there is only one README, one LICENSE, one INSTALL and so on ...
Perhaps another approach is to slimdown the README file and refer to other documentation using links to the other resources. This way you can emphasize any point you want in the main README and leave the other less used documentation for elsewhere. On Sunday, May 10, 2020 19:43 +03, Jacques Le Roux <[email protected]> wrote: Hi, We often get questions from people not reading the basic documentation. Like not able to run Gradle because ignoring init-gradle-wrapper scripts. I know there will always people not reading the documentation. But maybe, to prevent most obvious questions and tempting RTFM answers, we could add a small README.TXT with basic information in OFBiz root. It would ultimately refer to README.adoc. Also saying that README.adoc can be read with a text reader tool. And it's easy to follow https://asciidoctor.org/docs/convert-documents/#converting-a-document-to-html What do you think? Jacques
