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

Started work on build guide

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
docs/build.md
+17
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.