From 166732946e8d81c6a570b45c0a7da042d734dbcd Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Sun, 2 May 2021 15:57:38 +0200 Subject: [PATCH] Add a custom long description for PyPi --- README.md | 3 +-- setup.cfg | 2 +- setup/long_description.md | 21 +++++++++++++++++++++ 3 files changed, 23 insertions(+), 3 deletions(-) create mode 100644 setup/long_description.md diff --git a/README.md b/README.md index c5d87907..af613ee4 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,7 @@ [![macOS](https://github.com/vkbo/novelWriter/actions/workflows/test_mac.yml/badge.svg?branch=main)](https://github.com/vkbo/novelWriter/actions/workflows/test_mac.yml) [![flake8](https://github.com/vkbo/novelWriter/workflows/flake8/badge.svg)](https://github.com/vkbo/novelWriter/actions) [![codecov](https://codecov.io/gh/vkbo/novelWriter/branch/main/graph/badge.svg)](https://codecov.io/gh/vkbo/novelWriter) -[![docs](https://readthedocs.org/projects/novelwriter/badge/?version=latest)](https://novelwriter.readthedocs.io/en/latest/?badge=latest) - +[![docs](https://readthedocs.org/projects/novelwriter/badge/?version=latest)](https://novelwriter.readthedocs.io/en/latest/?badge=latest) [![release](https://img.shields.io/github/v/release/vkbo/novelwriter)](https://github.com/vkbo/novelWriter/releases) [![pypi](https://img.shields.io/pypi/v/novelwriter)](https://pypi.org/project/novelWriter) [![python](https://img.shields.io/pypi/pyversions/novelwriter)](https://pypi.org/project/novelWriter) diff --git a/setup.cfg b/setup.cfg index 01f6989b..0ef845b5 100644 --- a/setup.cfg +++ b/setup.cfg @@ -5,7 +5,7 @@ author = Veronica Berglyd Olsen author_email = code@vkbo.net description = A markdown-like document editor for writing novels url = https://novelwriter.io -long_description = file: README.md +long_description = file: setup/long_description.md long_description_content_type = text/markdown license_file = LICENSE.md license = GNU General Public License v3 diff --git a/setup/long_description.md b/setup/long_description.md new file mode 100644 index 00000000..ff60a17e --- /dev/null +++ b/setup/long_description.md @@ -0,0 +1,21 @@ + + +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. It's designed to be a simple text editor that allows +for easy organisation of text and notes, using human readable text files as storage for robustness. + +The project storage is 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, and other meta data is primarily saved as +JSON files. + +The application is written in Python 3 (3.6+) using Qt5 and PyQt5 (5.3+). It is developed on Linux, +but should in principle work fine on other operating systems as well as long as dependencies are +met. It is regularly tested on Debian and Ubuntu Linux, Windows, and macOS. + +novelWriter is developed and maintained by [Veronica Berglyd Olsen](https://github.com/vkbo). + +**Website:** https://novelwriter.io +**Documentation:** https://novelwriter.readthedocs.io +**Source Code:** https://github.com/vkbo/novelWriter