manuskript/README.md

70 lines
2.8 KiB
Markdown
Raw Normal View History

2016-02-07 00:44:45 +13:00
# Manuskript
2015-06-01 08:41:32 +12:00
2017-11-11 08:47:33 +13:00
[Manuskript](http://www.theologeek.ch/manuskript) is an open-source
tool for writers.
2015-06-01 08:41:32 +12:00
2021-12-14 05:17:43 +13:00
[![manuskript](https://snapcraft.io/manuskript/badge.svg)](https://snapcraft.io/manuskript)
2018-01-17 10:12:42 +13:00
Manuskript runs on GNU/Linux, Mac OS X, and Windows.
2016-02-07 00:44:45 +13:00
2017-11-11 08:47:33 +13:00
![Main view](http://www.theologeek.ch/manuskript/wp-content/uploads/2017/11/manuskript-0.5.0-main-view.jpg)
2016-02-07 00:44:45 +13:00
2017-11-11 08:47:33 +13:00
## Features
2016-03-31 22:20:26 +13:00
2017-11-11 08:47:33 +13:00
Manuskript provides a rich environment to help writers create their
first draft and then further refine and edit their masterpiece.
With Manuskript you can:
2016-02-07 00:44:45 +13:00
2017-11-11 08:47:33 +13:00
* Grow your premise from one sentence, to a paragraph, to a full
summary
* Create characters
* Conceive plots
* Construct outlines
([Outline mode](http://www.theologeek.ch/manuskript/2016/02/05/outliner/)
and/or
[Index cards](http://www.theologeek.ch/manuskript/2016/02/05/index-cards/))
* Write with focus
([Distraction free mode](https://github.com/olivierkes/manuskript/wiki/Full-screen-mode))
* Build worlds
* [Track items](https://github.com/olivierkes/manuskript/wiki/How-to-keep-track-of-important-items)
* Edit and re-organize chapters and scenes
* View [Story line](http://www.theologeek.ch/manuskript/2016/02/28/story-line/)
* Compose with
[fiction or non-fiction templates and writing modes](http://www.theologeek.ch/manuskript/2016/03/31/writing-modes-simple-fiction/)
* Import and export document formats such as HTML, ePub, OpenDocument, DocX, and
2017-11-11 08:47:33 +13:00
[more](https://github.com/olivierkes/manuskript/wiki/Import-and-Export-capabilities)
2016-02-07 00:44:45 +13:00
2017-11-11 08:47:33 +13:00
Additionally Manuskript can help in many more ways with a spell
checker, markdown highlighter,
[frequency analyzer](http://www.theologeek.ch/manuskript/2016/02/08/frequency-analyzer/),
and automatic save in
[open and plain text file format](http://www.theologeek.ch/manuskript/2016/03/31/open-plain-text-file-format/).
2016-02-07 00:44:45 +13:00
2017-11-11 08:47:33 +13:00
## Download
2015-06-08 08:06:57 +12:00
2017-11-11 08:47:33 +13:00
[Download](http://www.theologeek.ch/manuskript/download) and install Manuskript today.
## HowTo's
See the [Wiki](http://github.com/olivierkes/manuskript/wiki) for more
2017-11-11 08:47:33 +13:00
detailed instructions on how to install and use Manuskript.
## Contribute
You can help improve Manuskript by reporting
[issues](https://github.com/olivierkes/manuskript/issues), writing
[wiki documentation](https://github.com/olivierkes/manuskript/wiki),
and
[translating to other languages](https://github.com/olivierkes/manuskript/wiki/Translate-Manuskript).
See also
[Manuskript Contribute page](http://www.theologeek.ch/manuskript/contribute/).
Manuskript is written in Python3 and PyQt5.
## Free Software
Manuskript is [Free Software](https://www.gnu.org/philosophy/free-sw.html).
You have the freedom to run, copy, distribute, study, change and improve the software.
Manuskript is distributed under the [GNU General Public License](https://www.gnu.org/licenses/gpl.html) version 3 or (at your option) any later version.