Home

Installing

Install Binary (Easier)

• Manuskript Download
• Alternate Manuskript Download
• TIP: Install pandoc for more export document formats such as ePub, OpenDocument (LibreOffice), and DocX (MS Word).

Install Source Code (More Work, Runs on More OS Platforms)

• Run Manuskript from Source Code on Linux
• Run Manuskript from Source Code on Windows
• Run Manuskript from Source Code on Mac OS X

Using

How To...

• How to start a new project
• How to Use Manuskript to Write a Fiction Novel
• How to keep track of important items
• How to Add a Spellcheck Language Dictionary
• How to Add Images to a Project
• How to run manuskript globally, from anywhere (Linux)

Overview

• Overview of Manuskript Panes
• Overview of Manuskript Right Sidebar
• Overview of Manuskript Menu
• Overview of Manuskript Settings
• See answered questions in the issues tracker

Features

• Keyboard Shortcuts
• Fullscreen mode
• Documentation Snippets
• Import and Export capabilities

Mission Statement

The goal of Manuskript is to ease the task of writing large projects by providing facilities to stay organized and track details, while also keeping distractions to a minimum.

To maximize flexibility an open and plain text file format is used enabling collaboration with third-party tools.

For future plans, see the Roadmap.

Known Issues (Upcoming 0.10.0 release)

Qt 5.5.1 (Ubuntu 16.04 with end-of-life April 2021)

• Compile/export will silently overwrite existing file

Qt 5.11.x to 5.12.x

• Import will cause crash

PyQt 5.13.0

• Built with a broken OpenSSL library on Windows x64

Contributing

Developing

• All code changes and Pull Requests should be based on the develop branch.
• Tip: Add --console as last option on command line to use IPython Jupyter QT Console as a debugging aid.
• DRAFT SUPPORT STATEMENT - Subject to change
  We try to ensure that Manuskript will run on the currently supported versions of several major GNU/Linux distributions, in addition to commercially supported versions of Microsoft Windows and Apple macOS X. Operating Systems we often use in our testing include: Debian, Fedora, Ubuntu, and Windows.

Translating

• Translate Manuskript in a new language, or update existing translation

Packaging (for release package file)

• Package Manuskript for Linux with dpkg --> .deb
• Package Manuskript for Linux with rpm --> .rpm
• Package Manuskript for Linux with PyInstaller (Notes for linux packagers: removable files)
• Package Manuskript for Windows with PyInstaller
• Package Manuskript for OS X with PyInstaller
• Bundle manuskript for OS X with Platypus
• Package Manuskript for Linux with Stdeb - NOTE: Does Not Work
• [Packaging]-Generate-Windows-binaries-with-pyInstaller-(HowTo) - NOTE: Older HowTo
• Creating manuskript binary for Android and IOS - Help Wanted

Releasing Official Version

• Steps To Create An Official Manuskript Release