From 67a81400ff5dfff2d8cb7000b6a4f73b7eb34687 Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Sun, 25 Apr 2021 11:25:30 +0200 Subject: [PATCH] Clarify a few things about markup in the main readme --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b9341774..5ab7dbee 100644 --- a/README.md +++ b/README.md @@ -15,15 +15,16 @@ -novelWriter is a Markdown-like text editor designed for writing novels assembled from many smaller -text documents. It uses a minimal formatting syntax inspired by Markdown, and adds a meta data -syntax for comments, synopsis, and cross-referencing between files. It's designed to be a simple -text editor that allows for easy organisation of text files and notes, built on plain text files -for robustness. +novelWriter is a plain text editor designed for writing novels assembled from many smaller text +documents. It uses a minimal formatting syntax inspired by Markdown, and adds a meta data syntax +for comments, synopsis, and cross-referencing between files. It's designed to be a simple text +editor that allows for easy organisation of text and notes. It uses human readable text files for +storage for robustness. -The plain text files are suitable for version control software, and also well suited for file -synchronisation tools. The core project structure is stored in a single project XML file. Other -meta data is primarily saved in JSON files. +The storage text files are suitable for version control software, and also well suited for file +synchronisation tools. All text is saved as plain text files with a meta data header. The core +project structure is stored in a single project XML file. Other meta data is primarily saved in +JSON files. The full documentation is available on [readthedocs.io](https://novelwriter.readthedocs.io).