diff --git a/docs/build.md b/docs/build.md index 183315a..6c85201 100644 --- a/docs/build.md +++ b/docs/build.md @@ -9,7 +9,6 @@ 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 -<<<<<<< HEAD GitHub repository and checking out the `development-stable` 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 @@ -17,12 +16,6 @@ not a developer. Make sure that the repository is cloned into `/home/pi/TeraHz`, as Lighttpd expects to find frontend files inside this directory. -======= -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. ->>>>>>> 879cb28b9eba1b0ecaa60a43a0ec53070ea8f1e6 After cloning and checking out, check the documentation for module dependencies and the required version of python in the `docs/dependencies.md` file. @@ -34,7 +27,6 @@ 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. This leaves us with compiling Python from source. __This step is guaranteed to be slow, overnight compiling with something like tmux is recommended.__ -<<<<<<< HEAD ### Pre-requirements Installing python without most C libraries will lead to a rather minimalistic @@ -117,7 +109,7 @@ to run: - Hostapd - Wi-Fi access point They are available from the Raspbian repository. Install it via `apt`. - + ``` apt install hostapd dnsmasq hostapd ``` @@ -125,65 +117,3 @@ apt install hostapd dnsmasq hostapd ## Copying configuration files To simplify the process of configuring Raspbian to run TeraHz, sample configuration file are provided -======= - -### Pre-requirements -Installing python without most C libraries will lead to a rather minimalistic -Python install, missing a lot of important modules. To prevent this, update -the system packages. After that, reboot. - -``` -sudo apt update -sudo apt full-upgrade -sudo reboot -``` - -Install the required build tools, libraries and their headers. - -``` -sudo apt-get install build-essential tk-dev libncurses5-dev libncursesw5-dev libreadline6-dev libdb5.3-dev libgdbm-dev libsqlite3-dev libssl-dev libbz2-dev libexpat1-dev liblzma-dev zlib1g-dev -``` - -### Compiling -Compiling Python from source is, in fact pretty easy, just time-consuming. I'll -advise you again to use a terminal multiplexer like `tmux` to start the build -process, detach the terminal session overnight and reattach it some time later -to check on it. - -Python 3.6.8 can be downloaded in many forms, but you'll be using the most basic -of them all: a gzipped tarball. Download and decompress it, the cd into its -directory. - -``` -wget https://www.python.org/ftp/python/3.6.8/Python-3.6.8.tgz -tar -xzf Python-3.6.8.tgz -cd Python-3.6.8 -``` - -Python's build process is pretty classic, a `.configure` script and a Makefile. -Using the `-j` option with Make can reduce the compile time significantly. Go -with as many threads as you have cores: `-j 4` works great on the Pi 3 B/B+. - -``` -./configure -make -j4 -``` - -When the compilation ends, install your freshly built version of python. - -``` -sudo make altinstall -``` - -Altinstall means that the new version of Python will be installed beside the -existing version, and all related commands will use the full naming scheme: -think `python3.6` or `pip3.6` instead of the shorter `python3` or `pip3`. - -### Modules -Another painfully slow part is the installation of all the required modules needed -by TeraHz. Luckily, `pip3.6` takes care of the entire installation process. You might also want to run this command through a terminal multiplexer overnight, as it takes a few hours to complete. - -``` -pip3.6 install smbus pyserial flask pandas -``` ->>>>>>> 879cb28b9eba1b0ecaa60a43a0ec53070ea8f1e6 diff --git a/docs/dependencies.md b/docs/dependencies.md index 4aaca3d..e194fec 100644 --- a/docs/dependencies.md +++ b/docs/dependencies.md @@ -1,4 +1,4 @@ -# TeraHz `development-stable` dependencies +# 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 altinstall'd) diff --git a/docs/index.md b/docs/index.md index d388039..9130b39 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,2 @@ -# Welcome to MkDocs - -For full documentation visit [mkdocs.org](https://mkdocs.org). - -## Commands - -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs help` - Print this help message. - -## Project layout - - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +# TeraHz +TeraHz is a low-cost spectrometer. \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index c97182f..24153f0 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1 +1,4 @@ -site_name: My Docs +nav: + - Build guide: 'build.md' + - Development-stable dependencies: 'dependencies.md' + - Start page: 'index.md'