Started work on build guide

This commit is contained in:
Kristjan Komlosi
2019-06-21 10:13:03 +02:00
parent ee0d1184ed
commit 017721f659
2 changed files with 41 additions and 0 deletions

17
docs/build.md Normal file
View File

@@ -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.

24
docs/dependencies.md Normal file
View File

@@ -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
```