Reproog/novelWriter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'main' into dev

Browse Source
This commit is contained in:
Veronica K. B. Olsen
2021-04-25 11:27:13 +02:00
parent 51431169dd 67a81400ff
commit 1e48c6dcfe
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -8
View File
@@ -15,15 +15,16 @@
<img align="left" style="margin: 0 16px 4px 0;" src="https://raw.githubusercontent.com/vkbo/novelWriter/main/setup/icons/scaled/icon-novelwriter-96.png"> <img align="left" style="margin: 0 16px 4px 0;" src="https://raw.githubusercontent.com/vkbo/novelWriter/main/setup/icons/scaled/icon-novelwriter-96.png">
novelWriter is a Markdown-like text editor designed for writing novels assembled from many smaller novelWriter is a plain text editor designed for writing novels assembled from many smaller text
text documents. It uses a minimal formatting syntax inspired by Markdown, and adds a meta data documents. It uses a minimal formatting syntax inspired by Markdown, and adds a meta data syntax
syntax for comments, synopsis, and cross-referencing between files. It's designed to be a simple for comments, synopsis, and cross-referencing between files. It's designed to be a simple text
text editor that allows for easy organisation of text files and notes, built on plain text files editor that allows for easy organisation of text and notes. It uses human readable text files for
for robustness. storage for robustness.
The plain text files are suitable for version control software, and also well suited for file The storage 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 synchronisation tools. All text is saved as plain text files with a meta data header. The core
meta data is primarily saved in JSON files. 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). The full documentation is available on [readthedocs.io](https://novelwriter.readthedocs.io).