From de0b9dc8c4c32723e36f5c73973c4782ca1e3859 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcus=20Thelander=20Andr=C3=A9n?= <marcus.thelander_andren@control.lth.se> Date: Thu, 11 Apr 2019 16:06:33 +0200 Subject: [PATCH] Added dev page to docs --- docs/build/man/development.md | 47 ++++++++++++++++++++++++++++++++ docs/build/man/installation.md | 49 +--------------------------------- docs/src/index.md | 2 +- docs/src/man/development.md | 23 ++++++++++++++++ docs/src/man/installation.md | 26 +----------------- 5 files changed, 73 insertions(+), 74 deletions(-) create mode 100644 docs/build/man/development.md create mode 100644 docs/src/man/development.md diff --git a/docs/build/man/development.md b/docs/build/man/development.md new file mode 100644 index 0000000..aec7e66 --- /dev/null +++ b/docs/build/man/development.md @@ -0,0 +1,47 @@ + +<a id='Package-Development-1'></a> + +## Package Development + + +<a id='LabConnections.jl-Development-1'></a> + +### LabConnections.jl Development + + +If you want to develop the code in LabConnections.jl, then this is how you setup a development environment. First, open up a Julia REPL and type + + +``` +] dev https://gitlab.control.lth.se/labdev/LabConnections.jl +``` + + +Open a new terminal and navigate to `.julia/dev/LabConnections`, where the package source code is now located. Then type + + +``` +git checkout julia1 +git pull +``` + + +to ensure that you are working on the correct development branch for Julia v1.0.X. + + +<a id='SPI-Development-1'></a> + +### SPI Development + + +If you plan on working with the SPI devices to debug the ADC/DAC, then you will need a forked `serbus` repository which wraps the`linux/spi/spidev`. Simply + + +``` +`cd && cd .julia/v0.6' +`git clone https://github.com/mgreiff/serbus' +``` + + +to get the latest revision of the serbus fork. + diff --git a/docs/build/man/installation.md b/docs/build/man/installation.md index 99b697b..21b6b3e 100644 --- a/docs/build/man/installation.md +++ b/docs/build/man/installation.md @@ -45,7 +45,7 @@ Start by downloading the Debian image [here](http://beagleboard.org/latest-image ``` -mv /home/debian/julia-<distro specific tag>/bin/julia /home/debian/julia/bin/julia' +mv /home/debian/julia-<distro specific tag>/bin/julia /home/debian/julia/bin/julia ``` @@ -130,53 +130,6 @@ Then execute the commands After a while, the BeagleBone should start blinking on SysLED 2: on-off-on-sleep-repeat. The server should now start automatically on restart of the BeagleBone, and you should be able to run the examples in in /Examples on the host computer. -<a id='Package-Development-1'></a> - -## Package Development - - -<a id='LabConnections.jl-Development-1'></a> - -### LabConnections.jl Development - - -If you want to develop the code in LabConnections.jl, then this is how you setup a development environment. First, open up a Julia REPL and type - - -``` -] dev https://gitlab.control.lth.se/labdev/LabConnections.jl -``` - - -Open a new terminal and navigate to `.julia/dev/LabConnections`, where the package source code is now located. Then type - - -``` -git checkout julia1 -git pull -``` - - -to ensure that you are working on the correct development branch for Julia v1.0.X. - - -<a id='SPI-Development-1'></a> - -### SPI Development - - -If you plan on working with the SPI devices to debug the ADC/DAC, then you will need a forked `serbus` repository which wraps the`linux/spi/spidev`. Simply - - -``` -`cd && cd .julia/v0.6' -`git clone https://github.com/mgreiff/serbus' -``` - - -to get the latest revision of the serbus fork. - - <a id='Debugging-1'></a> ## Debugging diff --git a/docs/src/index.md b/docs/src/index.md index 02d150e..0db694b 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -5,7 +5,7 @@ CurrentModule = LabConnections ``` ## Getting Started ```@contents -Pages = ["man/introduction.md", "man/installation.md"] +Pages = ["man/introduction.md", "man/installation.md", "man/development.md"] Depth = 1 ``` ## Examples diff --git a/docs/src/man/development.md b/docs/src/man/development.md new file mode 100644 index 0000000..3250b92 --- /dev/null +++ b/docs/src/man/development.md @@ -0,0 +1,23 @@ +## Package Development + +### LabConnections.jl Development + +If you want to develop the code in LabConnections.jl, then this is how you setup a development environment. First, open up a Julia REPL and type +``` +] dev https://gitlab.control.lth.se/labdev/LabConnections.jl +``` +Open a new terminal and navigate to `.julia/dev/LabConnections`, where the package source code is now located. Then type +``` +git checkout julia1 +git pull +``` +to ensure that you are working on the correct development branch for Julia v1.0.X. + +### SPI Development + +If you plan on working with the SPI devices to debug the ADC/DAC, then you will need a forked `serbus` repository which wraps the`linux/spi/spidev`. Simply +``` +`cd && cd .julia/v0.6' +`git clone https://github.com/mgreiff/serbus' +``` +to get the latest revision of the serbus fork. diff --git a/docs/src/man/installation.md b/docs/src/man/installation.md index 193b545..3af1af7 100644 --- a/docs/src/man/installation.md +++ b/docs/src/man/installation.md @@ -21,7 +21,7 @@ Start by downloading the Debian image [here](http://beagleboard.org/latest-image Proceed by downloading the Julia v1.0 binary for 32-bit ARMv7 found [here](https://julialang.org/downloads/). Put the .tar-file of the Julia binary on the micro-SD card containing the Debian image under `/home/debian`, and unzip it. Make sure that the Julia folder has the correct name by typing ``` -mv /home/debian/julia-<distro specific tag>/bin/julia /home/debian/julia/bin/julia' +mv /home/debian/julia-<distro specific tag>/bin/julia /home/debian/julia/bin/julia ``` The file structure on the micro-SD now has the correct structure. @@ -69,30 +69,6 @@ Then execute the commands After a while, the BeagleBone should start blinking on SysLED 2: on-off-on-sleep-repeat. The server should now start automatically on restart of the BeagleBone, and you should be able to run the examples in in /Examples on the host computer. -## Package Development - -### LabConnections.jl Development - -If you want to develop the code in LabConnections.jl, then this is how you setup a development environment. First, open up a Julia REPL and type -``` -] dev https://gitlab.control.lth.se/labdev/LabConnections.jl -``` -Open a new terminal and navigate to `.julia/dev/LabConnections`, where the package source code is now located. Then type -``` -git checkout julia1 -git pull -``` -to ensure that you are working on the correct development branch for Julia v1.0.X. - -### SPI Development - -If you plan on working with the SPI devices to debug the ADC/DAC, then you will need a forked `serbus` repository which wraps the`linux/spi/spidev`. Simply -``` -`cd && cd .julia/v0.6' -`git clone https://github.com/mgreiff/serbus' -``` -to get the latest revision of the serbus fork. - ## Debugging -- GitLab