mirrors
/
tuhi
mirror of https://github.com/tuhiproject/tuhi.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Installation (markdown)

master
Peter Hutterer 2019-08-09 15:40:48 +10:00
parent 3803525d77
commit 51467fb52c
1 changed files with 26 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
Installation.md

@ -1,42 +1,48 @@
# Running from git
Tuhi can run from the git repository without the need to build anything. Simply check out the code and run `tuhi.py` from the git repository.
Tuhi uses the [meson build system](http://mesonbuild.com). It requires the following packages to be installed:
- Fedora: `python3-devel` and `pygobject3-devel`
- Debian/Ubuntu: `python3-dev` and `python3-gi`
To build Tuhi, run the following commands:
```
$> git clone http://github.com/tuhiproject/tuhi
$> meson builddir
$> ninja -C builddir
$> ./builddir/tuhi.devel
```
Note the special binary `tuhi.devel`, it is provided to run everything from the git repository.
# Installation
To install, simply run `ninja -C builddir install` after the `meson` stage:
```
$> git clone http://github.com/tuhiproject/tuhi
$> cd tuhi
$> ./tuhi.py
```
# Installation using setuptools
Tuhi is a pure python program and uses [setuptools](https://setuptools.readthedocs.io/en/latest/) for installation. The installation procedure is the default sequence of commands for any `setup.py`-based project:
```
$> git clone http://github.com/tuhiproject/tuhi
$> cd tuhi
$> python3 setup.py install
$> meson builddir
$> ninja -C builddir install
$> tuhi
```
Please see the [setuptools](https://setuptools.readthedocs.io/en/latest/) documentation for more information.
Note that we now run `tuhi` instead of `tuhi.devel` - this is the system-installed version that uses system-wide modules.
# Installation through flatpak
Alternatively, you can build a local [flatpak](https://flatpak.org/) and run that. For that, you need the correct SDK installed
```
$> flatpak --user install org.freedesktop.Sdk/x86_64/18.08
$> flatpak --user install org.gnome.Sdk/x86_64/3.30
```
This SDK is used by several applications, so you may already have it installed. Leaving out the `--user` argument installs it system-wide.
```
$> git clone http://github.com/tuhiproject/tuhi
$> cd tuhi
$> flatpak-builder --user build-dir --force-clean org.freedesktop.tuhi.json
... this builds all dependencies as well
$> flatpak-builder --run build-dir org.freedesktop.tuhi.json tuhi-kete
... this starts tuhi in the background and provides kete, the commandline utility
$> flatpak-builder --install --user build-dir --force-clean org.freedesktop.Tuhi.json
... this builds all dependencies as well and install the flatpak
$> flatpak run org.freedesktop.Tuhi
```
No system dependencies are installed, removing the `build-dir` will remove all installed files.
To remove Tuhi, run `flatpak remove org.freedesktop.Tuhi`.