mirror of
https://github.com/olivierkes/manuskript.git
synced 2024-09-29 08:51:14 +13:00
Add selection of directory for manuskript installation
parent
3852741f32
commit
7c6d5c23e0
1 changed files with 22 additions and 8 deletions
|
@ -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.
|
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
|
## 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.
|
* 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**
|
||||||
|
|
||||||
## 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
|
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
|
## 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
|
git clone https://github.com/olivierkes/manuskript.git
|
||||||
|
|
||||||
|
The above command will create a _manuskript_ subdirectory. Change into this subdirectory.
|
||||||
|
|
||||||
cd manuskript
|
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.
|
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.
|
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
|
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
|
apt install python3-enchant
|
||||||
|
|
||||||
## Run manuskript
|
# Run Manuskript
|
||||||
|
|
||||||
|
## Run manuskript from Source Code
|
||||||
|
|
||||||
bin/manuskript
|
bin/manuskript
|
||||||
|
|
||||||
|
The above command assumes you are in the directory in which you installed manuskript.
|
Loading…
Reference in a new issue