Repository files navigation

novelWriter is a plain text editor designed for writing novels assembled from many smaller textdocuments. It uses a minimal formatting syntax inspired by Markdown, and adds a meta data syntaxfor comments, synopsis, and cross-referencing. It's designed to be a simple text editor that allowsfor 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 filesynchronisation tools. All text is saved as plain text files with a meta data header. The coreproject structure is stored in a single project XML file. Other meta data is primarily saved asJSON files.

For more details, and how to install and use novelWriter, please see the main website anddocumentation.

Project Links

• Website:novelwriter.io
• Documentation:docs.novelwriter.io
• Internationalisation:crowdin.com/project/novelwriter
• PyPi Project:pypi.org/project/novelWriter
• Social Media:fosstodon.org/@novelwriter

Free code signing on Windows provided bySignPath.io, certificate bySignPath Foundation.

novelWriter is written with Python 3 (3.10+) using Qt6 and PyQt6 (6.4+), and is released onLinux, Windows and macOS. It can in principle run on any Operating System that also supports Qt,PyQt and Python.

Please don't make feature pull requests without first having discussed them with the maintainer.You can make a feature request in the issue tracker, or if the idea isn't fully formed, start adiscussion on the discussion page. Please also don't make pull requests to reformat or rewriteexisting code unless there is a very good reason for doing so.

Fixes and patches are welcome. Contributions related to packaging and installing novelWriter willalso be appreciated, but please make an issue or a discussion topic first. Before contributing anycode, please also read the fullContributing Guide.

Project credits are available inCREDITS.md.

Note: As of April 2024 only pre-releases are made from themain branch. Full releases aremade from therelease branch. So if you're submitting a fix to a current release,includingchanges to documentation, they must be made to therelease branch.

New translations are always welcome. This project uses Crowdin to maintain translations, and youcan contribute translations at theCrowdin project page.If you have any questions, feel free to post them to theTranslations of novelWriter issue thread.

For more details, and how to use Qt Linguist for translations, see thei18n instructions.

This is Open Source software, and novelWriter is licenced under GPLv3. See theGNU General Public License website for moredetails, or consult theLicensedocument. Bundled assets and their licences are listed in theCredits document.