CodeMirror/manuskript
1
0
Fork 0
mirror of https://github.com/olivierkes/manuskript.git synced 2024-06-02 11:04:33 +12:00
Code Issues Projects Releases Wiki Activity

Update instructions to cover more GNU/Linux distributions

Curtis Gedak 2017-05-24 10:03:30 -06:00
parent b4140fe35f
commit 5600f3f7be
1 changed files with 21 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
Installation-on-Linux-(Debian-or-Ubuntu).md → Run-Manuskript-from-Source-Code-on-Linux.md

@ -1,11 +1,18 @@
# Summary
This is a guide for running manuskript from source code on GNU Linux distributions based on Debian, such as Ubuntu.
This guide outlines the steps for running **manuskript** from source code on _Debian_ and Debian based GNU/Linux distributions , such as _Ubuntu_ or _Mint_. These commands may work for other distros as well, though there may be some differences in the package names.
The guide explains how to install all necessary dependencies, and then how to run the software.
* _Fedora_ or _CentOS_ - use `yum` or `dnf` package command instead of `apt`.
* _openSuse_ - use `zypper` package command instead of `apt`
This guide explains how to install all necessary dependencies, and how to invoke the software.
Every command in this guide should be run in a terminal session.
Note that some commands require root privilege and hence are prefixed with the `sudo` command. If `sudo` does not work then try using `su -c ` instead.
## Open Terminal Session
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.
@ -13,36 +20,38 @@ Following are some ways to invoke a terminal session with different window manag
* 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**
Note that some commands require root privilege and hence are prefixed with the `sudo` command. If `sudo` does not work then try using the `su -c ` prefix instead.
## Install git:
## Install git
### git
git is a distributed version control system. The source code for **Manuskript** is managed with git.
git is a distributed version control system. The source code for **Manuskript** is managed with git and hence we need git to be able to clone a copy of the source code.
sudo apt install git-core
The command `sudo` is used to acquire root privilege required to install software packages.
Note that the command `sudo` is used to acquire root privilege required to install software packages.
## Download sources:
## Download Source Code
Use git to clone a copy of the source code to your computer.
git clone https://github.com/olivierkes/manuskript.git
cd manuskript
## Optional: switch to the develop branch (latest unreleased version)
At any time after you have cloned the source code, you can update your copy to the latest version with the `git pull` command.
## Optional: Switch to the develop Branch (latest unreleased version)
git checkout develop
## Install required dependencies:
Note that you can return to the master branch with the `git checkout master` command.
## Install Required Dependencies
sudo apt install python3 python3-pyqt5 python3-pyqt5.qtwebkit libqt5svg5 python3-lxml zlib1g
(accept other dependencies proposal)
## Install optional dependencies:
## Install Optional Dependencies
### PyEnchant
@ -50,6 +59,6 @@ PyEnchant is used for spellchecking.
apt install python3-enchant
## Run manuskript:
## Run manuskript
bin/manuskript