Place software dependencies before manuskript source code installation

Curtis Gedak 2017-05-24 12:43:39 -06:00
parent 35a5a514bd
commit 2ab4e31e0c

@ -1,8 +1,8 @@
# Summary
# SUMMARY
This guide describes the steps for installing and running **Manuskript** on Linux.
This guide describes the steps for installing and running **Manuskript** from source code on Linux.
The steps include installing all necessary dependencies, and invoking manuskript from source code. The steps focus on _Debian_ and Debian based GNU/Linux distributions , such as _Ubuntu_ or _Mint_. These commands may also work for other distros, though there may be some differences in the package names.
The steps include installing all necessary software dependencies. These steps focus on _Debian_ and Debian based GNU/Linux distributions , such as _Ubuntu_ or _Mint_. These commands may also work for other distros, though there may be some differences in the package names.
* _Fedora_ or _CentOS_ - use `yum` or `dnf` package command instead of `apt`.
* _openSuse_ - use `zypper` package command instead of `apt`
@ -16,13 +16,29 @@ If `sudo` does not work then try using `su -c ` instead.
Following are some ways to invoke a terminal session with different window managers:
* GNOME:   Left-click on **Activities**, then click on the **Terminal** icon on the left-hand side of the screen.
* KDE:   Use menu option **K -> System -> Konsole**
* GNOME: Left-click on **Activities**, then click on the **Terminal** icon on the left-hand side of the screen.
* KDE:     Use menu option **K -> System -> Konsole**
* LXDE:   Use menu option **L -> Accessories -> LXTerminal**
* Unity:   Left-click on the **Search** icon in the upper left-hand corner, type in `terminal`, then click on the **terminal** icon.
* XFCE4:   Use menu option **Applications Menu -> System -> XFCE Terminal**
* XFCE4: Use menu option **Applications Menu -> System -> XFCE Terminal**
# Installation
# INSTALLATION
## Install Required Software Packages
Manuskript is written in Python (v3) programming language and uses the cross-platform QT (v5) UI framework and also requires some additional software.
sudo apt install python3 python3-pyqt5 python3-pyqt5.qtwebkit libqt5svg5 python3-lxml zlib1g
_Accept other dependencies proposal._
## Install Optional Dependencies
### PyEnchant
PyEnchant is used for spellchecking.
apt install python3-enchant
## Install Git
@ -54,26 +70,10 @@ At any time after you have cloned the source code, you can update your copy to t
Note that you can return to the master branch with the `git checkout master` command.
## Install Python, QT and Other Required Dependencies
Manuskript is written in Python (v3) and QT (v5) and requires some additional software.
sudo apt install python3 python3-pyqt5 python3-pyqt5.qtwebkit libqt5svg5 python3-lxml zlib1g
(accept other dependencies proposal)
## Install Optional Dependencies
### PyEnchant
PyEnchant is used for spellchecking.
apt install python3-enchant
# Run Manuskript
# EXCECUTION
## Run manuskript from Source Code
bin/manuskript
The above command assumes you are in the directory in which you installed manuskript.
The above command assumes you are in the directory in which you installed manuskript.