From 017721f6594755631f728dbe90c8890bf77413df Mon Sep 17 00:00:00 2001 From: Kristjan Komlosi Date: Fri, 21 Jun 2019 10:13:03 +0200 Subject: [PATCH] Started work on build guide --- docs/build.md | 17 +++++++++++++++++ docs/dependencies.md | 24 ++++++++++++++++++++++++ 2 files changed, 41 insertions(+) create mode 100644 docs/build.md create mode 100644 docs/dependencies.md diff --git a/docs/build.md b/docs/build.md new file mode 100644 index 0000000..a5baf51 --- /dev/null +++ b/docs/build.md @@ -0,0 +1,17 @@ +# TeraHz build guide +The recommended way of getting TeraHz is the official SD card image provided +under the releases tab in the GitHub repository. Installing TeraHz from source +is a time consuming and painful process, even more so if you don't know what +you're doing, and whatever you end up building __will not be officially +supported__ (unless you're a core developer). + +With this warning out of the way, let's begin. + +## Getting the latest sources +The most reliable way to get working source code is by cloning the official GitHub +repository and checking out the `development-working` tag. This tag marks the latest +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. diff --git a/docs/dependencies.md b/docs/dependencies.md new file mode 100644 index 0000000..6e3da66 --- /dev/null +++ b/docs/dependencies.md @@ -0,0 +1,24 @@ +# TeraHz `development-stable` dependencies +The current development version of TeraHz has been verified to work with: + - Raspbian Stretch (9) + - Python 3.6.8 (built from source code and altinstalled) + - Module versions (direct `pip3.6 list` output): + ``` + Package Version + --------------- --------- + Click 7.0 + Flask 1.0.3 + itsdangerous 1.1.0 + Jinja2 2.10.1 + MarkupSafe 1.1.1 + numpy 1.16.4 + pandas 0.24.2 + pip 18.1 + pyserial 3.4 + python-dateutil 2.8.0 + pytz 2019.1 + setuptools 40.6.2 + six 1.12.0 + smbus 1.1.post2 + Werkzeug 0.15.4 + ```