From 7c6d5c23e05d4a02768f6400c172581901750a53 Mon Sep 17 00:00:00 2001 From: Curtis Gedak Date: Wed, 24 May 2017 11:12:36 -0600 Subject: [PATCH] Add selection of directory for manuskript installation --- Run-Manuskript-from-Source-Code-on-Linux.md | 30 +++++++++++++++------ 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/Run-Manuskript-from-Source-Code-on-Linux.md b/Run-Manuskript-from-Source-Code-on-Linux.md index 6cb3940..4b4ba6a 100644 --- a/Run-Manuskript-from-Source-Code-on-Linux.md +++ b/Run-Manuskript-from-Source-Code-on-Linux.md @@ -9,7 +9,8 @@ The steps include installing all necessary dependencies, and invoking manuskript 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. +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 @@ -21,11 +22,11 @@ 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** -## Install git +# Installation -### git +## Install 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. +The source code for **Manuskript** is managed with the _git_ distributed version control system, and hence we need git to be able to clone a copy of the source code. sudo apt install git-core @@ -33,9 +34,16 @@ Note that the command `sudo` is used to acquire root privilege required to insta ## Download Source Code -Use git to clone a copy of the source code to your computer. +Choose a directory to install the source code. For example, your home directory: + + cd /home/your-user-name + +Use git to clone a copy of the source code your chosen directory. git clone https://github.com/olivierkes/manuskript.git + +The above command will create a _manuskript_ subdirectory. Change into this subdirectory. + cd manuskript At any time after you have cloned the source code, you can update your copy to the latest version with the `git pull` command. @@ -46,7 +54,9 @@ 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 Required Dependencies +## 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 @@ -60,6 +70,10 @@ PyEnchant is used for spellchecking. apt install python3-enchant -## Run manuskript +# Run Manuskript - bin/manuskript \ No newline at end of file +## Run manuskript from Source Code + + bin/manuskript + +The above command assumes you are in the directory in which you installed manuskript. \ No newline at end of file