manuskript/README.md

43 lines
1.2 KiB
Markdown
Raw Normal View History

2016-02-07 00:44:45 +13:00
# Manuskript
2015-06-01 08:41:32 +12:00
2016-02-07 00:44:45 +13:00
[Manuskript](http://www.theologeek.ch/manuskript) is an open-source tool for writers.
2015-06-01 08:41:32 +12:00
2016-03-31 22:20:26 +13:00
![Main view](http://www.theologeek.ch/manuskript/wp-content/uploads/2016/03/manuskript-0.3.0.jpg)
2016-02-07 00:44:45 +13:00
2016-03-31 22:21:25 +13:00
## [Download](http://www.theologeek.ch/manuskript/download)
2016-03-31 22:20:26 +13:00
2016-02-07 00:44:45 +13:00
## Running from sources
To run the application without installing just:
* 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!
2016-02-07 00:44:45 +13:00
## Dependencies
2015-06-08 08:06:57 +12:00
- Python 3
- PyQt5
2016-04-08 22:02:50 +12:00
- Qt SVG (`libqt5svg5` on Ubuntu)
- Qt Webkit (`python3-pyqt5.qtwebkit` on Ubuntu)
- lxml (`python3-lxml` on Ubuntu)
2015-06-08 08:06:57 +12:00
Optional:
2015-06-17 23:25:46 +12:00
- pyenchant
2016-03-31 22:20:26 +13:00
- 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.):
2017-03-24 23:44:44 +13:00
```sudo apt-get install python3-pyqt5 libqt5svg5 python3-lxml python3-enchant zlib1g```
2017-03-25 00:05:43 +13:00
Additional packages that might be needed: ``python3-pyqt5.qtwebkit pyqt5-dev-tools``
## 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.