Created Installation (markdown)

Peter Hutterer 2019-06-07 15:35:03 +10:00
parent 30b70bb596
commit b4af15b89f
1 changed files with 29 additions and 0 deletions

29
Installation.md Normal file

@ -0,0 +1,29 @@
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
$> tuhi
```
Please see the [setuptools](https://setuptools.readthedocs.io/en/latest/) documentation for more information.
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
```
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
[... builds all dependencies as well ...]
$> flatpak-builder --run build-dir org.freedesktop.tuhi.json tuhi
[ tuhi is now running, background it or start a new shell ]
$> flatpak-builder --run build-dir org.freedesktop.tuhi.json tuhi-kete
[ kete is the
```
No system dependencies are installed, removing the `build-dir` will remove all installed files.