From 36b4321345417de33ab11eb338f482717a7610d9 Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Wed, 20 May 2020 23:50:02 +0200 Subject: [PATCH] Added a bit more info, including license, to README --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9e6863da..19588559 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,18 @@ -# ![Logo](assets/icons/24x24/novelwriter.png) novelWriter +# novelWriter [![Build Status](https://travis-ci.com/vkbo/novelWriter.svg?branch=master)](https://travis-ci.com/vkbo/novelWriter) [![codecov](https://codecov.io/gh/vkbo/novelWriter/branch/master/graph/badge.svg)](https://codecov.io/gh/vkbo/novelWriter) [![Documentation Status](https://readthedocs.org/projects/novelwriter/badge/?version=latest)](https://novelwriter.readthedocs.io/en/latest/?badge=latest) + novelWriter is a markdown-like text editor designed for writing novels and larger projects of many smaller plain text documents. +novelWriter uses its own flavour of markdown that supports mete data syntax for comments, synopsis and cross-referencing between files. -The documentation is available here: [novelwriter.readthedocs.io](https://novelwriter.readthedocs.io/). +novelWriter is licensed under GPLv3, see the [GNU General Public License website](https://www.gnu.org/licenses/gpl-3.0.en.html) for more details, or consult the [LICENSE](LICENSE.md) file. +The bundled Typicon-based icon themes are licensed under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/). + +Below is a short overview of the features of novelWriter. +The full documentation is available at [novelwriter.readthedocs.io](https://novelwriter.readthedocs.io/). ### Note