Splitt README.md

[andreas-roehler]

Splitt README.md into README.md, USAGE.md, INSTALL.md

Allow faster orientation and easier edits

[lex-lex]

Hi Andreas,

i just thought about the changes to the README and had some seconds thoughts on the strict separation of the three parts:

• I'm fine with the extraction of the INSTALL and USAGE part from the whole README. That should make the first appearance more structured and inviting
• Nevertheless, from a "user friendliness" perspective, I think if we completely eliminate both aspects from the README, the psychological barrier to actually install and use the system is higher if additional, separated "chapters" are seemingly required to explain how it works.
• Hence, what about a compromise: The Install and Usage part within README contains just a small paragraph (like the most common install routine/use case, respectively) about the topic. Under this very short excursion, the links to the dedicated documents are placed with a remark to "look there for further information".

I'm thinking of somethink like:

---

[...]

Install

Just download xxx and execute leo3. Further information about installation and building Leo-III form source can be read in the INSTALL.

Usage

Leo is invoked by ./leo3 <problem> [<option1>,[<option2>,[...]*]] and returns a SZS result value yada yada. More information about the usage of Leo-III and its various parameters, further features, etc can be found ...yada yada [...]

---

Also, prominent features of Leo-III that makes it special (modal logic reasoning, polymorphic reasoning etc.) should at least be mentioned briefly in the README.

What do you think about that?

[andreas-roehler]

Hmm, following the last part WRT to prominent features. Also with splitting the work certainly isn't done, a further cleanup and extending should follow. IMO every section should be complete and kind of hierachical. Giving some details an prominent place without surrounding info doesn't look useful. The precise case was a stumpling about the download advice - which doesn't tell about the directory etc. But understanding is also a personal thing. So lets try your suggestion. We can change it at any time later if important. BTW I'm still struggling with the links. Don't see how to write relative links. only a complete URL works for now.

[lex-lex]

IMO every section should be complete and kind of hierachical.

Yes, of course. That is true.

Giving some details an prominent place without surrounding info doesn't look useful.

The idea is that only those important information are given on the ovewview page that do not need surrounding information.

But I'll guess we move this discussion to other channels. Thanks for your work!

[andreas-roehler]

On 08.01.2018 13:04, Alexander Steen wrote:

IMO every section should be complete and kind of hierachical.
Yes, of course. That is true.

Giving some details an prominent place without surrounding info
doesn't look useful.
The idea is that only those important information are given on the
ovewview page that do not need surrounding information.

But I'll guess we move this discussion to other channels. Thanks for your work!

My thanks too.

BTW IIRC exists some general leo-dev list. Maybe use this, so others may participate?

Cheers,

Andreas