forked from olivierkes/manuskript
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request olivierkes#205 from gedakc/update-readme
Update README.md for 0.5.0 release
- Loading branch information
Showing
1 changed file
with
52 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,42 +1,67 @@ | ||
# Manuskript | ||
|
||
[Manuskript](http://www.theologeek.ch/manuskript) is an open-source tool for writers. | ||
[Manuskript](http://www.theologeek.ch/manuskript) is an open-source | ||
tool for writers. | ||
|
||
![Main view](http://www.theologeek.ch/manuskript/wp-content/uploads/2016/03/manuskript-0.3.0.jpg) | ||
Manuskript runs on on GNU/Linux, Mac OS X, and Windows. | ||
|
||
![Main view](http://www.theologeek.ch/manuskript/wp-content/uploads/2017/11/manuskript-0.5.0-main-view.jpg) | ||
|
||
## [Download](http://www.theologeek.ch/manuskript/download) | ||
## Features | ||
|
||
## Running from sources | ||
Manuskript provides a rich environment to help writers create their | ||
first draft and then further refine and edit their masterpiece. | ||
With Manuskript you can: | ||
|
||
To run the application without installing just: | ||
* 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/) | ||
* Export to HTML, ePub, OpenDocument, DocX, PDF, and | ||
[more](https://github.com/olivierkes/manuskript/wiki/Import-and-Export-capabilities) | ||
|
||
* Download [latest code archive](https://github.com/olivierkes/manuskript/archive/master.zip) or clone the repository. | ||
* Run: | ||
* On Linux/Mac: bin/manuskript | ||
|
||
Be sure to have all **dependencies** installed! | ||
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/). | ||
|
||
## Dependencies | ||
- Python 3 | ||
- PyQt5 | ||
- Qt SVG (`libqt5svg5` on Ubuntu) | ||
- Qt Webkit (`python3-pyqt5.qtwebkit` on Ubuntu) | ||
- lxml (`python3-lxml` on Ubuntu) | ||
## Download | ||
|
||
Optional: | ||
- pyenchant | ||
- zlib | ||
|
||
### To install dependencies on Linux: | ||
- Arch Linux: | ||
```sudo pacman -S --needed python python-pyqt5 qt5-svg python-lxml python-pyenchant zlib``` | ||
|
||
- Debian based (Ubuntu, Linux Mint, etc.): | ||
```sudo apt-get install python3-pyqt5 libqt5svg5 python3-lxml python3-enchant zlib1g``` | ||
Additional packages that might be needed: ``python3-pyqt5.qtwebkit pyqt5-dev-tools`` | ||
[Download](http://www.theologeek.ch/manuskript/download) and install Manuskript today. | ||
|
||
## HowTo's | ||
|
||
See the [Wiki](http://github.com/olivierkes/manuskript/wiki) for more | ||
detailed instructions on how to install on GNU/Linux, Windows, and OS X. | ||
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. |