kristjank/TeraHz
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Build docs and config fixes

Browse Source
This commit is contained in:
Kristjan Komlosi
2019-06-21 15:27:44 +02:00
parent 919dd41321
commit 6c37a7b1a9
2 changed files with 19 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/build.md
View File

@@ -14,4 +14,21 @@ confirmed working commit. Building from the master branch is somewhat risky, and
building from development branches is straight up stupid if you're not a developer.
After cloning and checking out, check the documentation for module dependencies
and the required version of python.
and the required version of python in the `docs/dependencies.md` file.
## Installing Python
This step depends a lot on the platform you're using. TeraHz was developed with
Raspberry Pi and Raspbian in mind. If you're familiar with Raspbian enough,
you'll know that the latest version of Python available is `3.5`, which is too
obsolete to run TeraHz and the required modules consistently.
After messing with Debian arm64 packages in the early development days I determined
that the most reliable way of getting Python on Raspbian is compiling it from source.
This part of the installation will take the largest portion of time, as compiling
anything complex on the Raspberry is painfully slow.
If you're running an OS that provides a recent version of Python, great! You won't
have to waste so much time waiting for the build process to finish.
The Python version TeraHz works best on is `3.6.8`. To install it, download the
gzipped tarball from the official Python website, and decompress it.