Skip to content

README -- What it is, and How to use it

Martin Lange requested to merge write-readme into main

Added the complete content of the README.md file: What is this template for, and how to use it.

The aim of the text is to provide a comprehensible usage guide, and to provide sufficient information to give the potential user an idea what could be achieved with mdBook.
An independent trial of the explained procedure is appreciated.

Not sure if forking is really the best option.

Other options may be simpler, like clone -> delete .git -> push to new, or download .zip -> push to new.
However, both would not work for someone who wants to write online rather than using Git.

Code review advices:

  • View the diffs in the Changes tab (above)
  • Comment directly on code lines using the speech bubble icons
  • View the rendered version by switching to branch write-readme on the main page (or here)

Fixes #1 (closed)

Edited by Martin Lange

Merge request reports