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

Some updates to the readme.

Browse Source
This commit is contained in:
Veronica K. B. Olsen
2018-10-27 16:37:28 +02:00
parent 83ea8c4f4f
commit 08f990ead1
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11 -4
View File
@@ -1,15 +1,22 @@
# novelWriter # novelWriter
This is a reboot of my novelWriter application using Qt5 after abandoning the Gtk3 version now renamed novelWriterGtk. This is a reboot of my novelWriter application using Qt5 after abandoning the Gtk3 version now renamed novelWriterGtk.
The first usable version is under initial development.
As an amateur science fiction writer, I have been looking for a simple tool to organise text files into a novel. The application is written with Python3 and PyQt5, and developed on Linux. I will try to make sure it works on Windows as well.
While there are a number of tools ranging from the excellent distraction free editors to complex project organisers, there isn't anything that combines the features I am looking for. **Note:** This application is designed specifically for my own needs as I work on my projects.
I will only add features as I need them. I am trying to make the application as general as possible within that limitation.
## Features
The file format for the written text is plain html as generated by the Qt5 text editor. Meta data is stored as XML.
Here is an overview of the core features I want to implement as a starting point: Here is an overview of the core features I want to implement as a starting point:
* Multi-tabbed editor allowing the user to work on multiple files at the same time. * A simple rich text editor with a minimal set uf text decoration features.
* A non-sorted tree view for easy navigation between the files. The tree view must not be sorted automatically as one wants to order the scene or chapter files in the order they should appear in the finished novel. * The structure of the novel is broken down into individual scene files within chapters.
* A non-sorted tree view for easy navigation between the scene files. The elements of the tree reflect the order they appear in the chapters.
* Scene meta data including POV, character, location, plot and timeline information in a tag-style manner. * Scene meta data including POV, character, location, plot and timeline information in a tag-style manner.
* Basic visualisation tools for the novel meta data. * Basic visualisation tools for the novel meta data.
* The file format should be such that version control software can be used for the projects. That is, no binary files. * The file format should be such that version control software can be used for the projects. That is, no binary files.