diff --git a/docs/build/examples/examples.md b/docs/build/examples/examples.md index 7a6fecea5875f37b39080a25682afdd919f63e73..0ab33e8d2e86d25c3beecffef584109e0e309b8b 100644 --- a/docs/build/examples/examples.md +++ b/docs/build/examples/examples.md @@ -4,7 +4,7 @@ # Examples -The following examples may be run from the BB, and may require the user to export the the LabConnections module to the LOAD_PATH manually, executing the following line in the Julia prompt +The following examples may be run from the BeagleBone (BB), and may require the user to export the the LabConnections module to the LOAD_PATH manually, executing the following line in the Julia REPL (while SSH:d into the BB) ``` @@ -12,7 +12,7 @@ push!(LOAD_PATH, "/home/debian/juliapackages") ``` -When running the examples with hardware in the loop, take caution not to short the BB ground with any output pin, as this will damage the board. For instance, if connecting a diode to the output pins, always use a resistor of >1000 Ohm in parallel. See the configuration page for information on which functionality specific pins support. +When running the examples with hardware in the loop, take caution not to short the BBB ground with any output pin, as this will damage the board. For instance, if connecting a diode to the output pins, always use a resistor of >1000 Ohm in parallel. <a id='Example-with-LEDs-(BB)-1'></a> diff --git a/docs/build/examples/testing.md b/docs/build/examples/testing.md index d6c3c7465c1d1abf2caf5934ed777f071c0a9993..e65cc55a8081f546824d1dba458c925cc4556d9f 100644 --- a/docs/build/examples/testing.md +++ b/docs/build/examples/testing.md @@ -1,10 +1,10 @@ -<a id='Tests-1'></a> +<a id='Testing-1'></a> -# Tests +# Testing -The BeagleBone tests can be run on any computer, regrdless of their file-syste. By setting the flag RUNNING_TESTS to true, a dummy file-system is exported in which the tests are run operate. This has the advantage of enabling testing of the code run on the BB free from the BB itself, without building the Debian FS, thereby enabling the automatic testing through Travis. +The BeagleBone tests can be run on any computer, regardless of their file-system. By setting the flag RUNNING_TESTS to true, a dummy file-system is exported in which the tests are run operate. This has the advantage of enabling testing of the code run on the BB free from the BB itself, without building the Debian FS, thereby enabling the automatic testing through Travis. To run the tests, simply enter the /test/ directory and run diff --git a/docs/build/index.md b/docs/build/index.md index 9ff9ffcd5e7dd57559cf22888c7e850ea1baef0f..b20963998205e517d0f793e84e51eb0659d860b2 100644 --- a/docs/build/index.md +++ b/docs/build/index.md @@ -19,7 +19,14 @@ ## Examples - [Examples](examples/examples.md#Examples-1) -- [Tests](examples/testing.md#Tests-1) + + +<a id='Development-1'></a> + +## Development + +- [Package Development](man/development.md#Package-Development-1) +- [Testing](examples/testing.md#Testing-1) <a id='Functions-1'></a> diff --git a/docs/build/man/development.md b/docs/build/man/development.md index 256b57aea740684bb10bc4acb2d1fd7c4b5e87b8..7b2e4be67a8d20090e72e50f788d86ce7653272d 100644 --- a/docs/build/man/development.md +++ b/docs/build/man/development.md @@ -1,12 +1,12 @@ <a id='Package-Development-1'></a> -## Package Development +# Package Development -<a id='LabConnections.jl-Development-1'></a> +<a id='Development-environment-1'></a> -### LabConnections.jl Development +## Development environment 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 @@ -26,5 +26,5 @@ git pull ``` -to ensure that you are working on the correct development branch for Julia v1.0.X. +to ensure that you are working on the correct development branch for Julia v1.0.X. You can now edit the code in `.julia/dev/LabConnections` and run it using a Julia REPL. When you are satisfied with your changes, simply commit and push the changes in the `.julia/dev/LabConnections` directory to the GitLab server. diff --git a/docs/src/examples/examples.md b/docs/src/examples/examples.md index 4bac901e57e4ee2d46602416c9ddc989e2a81b21..27472503f5a958e773b020ba3db16923fb17e224 100644 --- a/docs/src/examples/examples.md +++ b/docs/src/examples/examples.md @@ -1,15 +1,14 @@ # Examples -The following examples may be run from the BB, and may require the user to +The following examples may be run from the BeagleBone (BB), and may require the user to export the the LabConnections module to the LOAD_PATH manually, executing the -following line in the Julia prompt - - push!(LOAD_PATH, "/home/debian/juliapackages") - +following line in the Julia REPL (while SSH:d into the BB) +``` +push!(LOAD_PATH, "/home/debian/juliapackages") +``` When running the examples with hardware in the loop, take caution not to short -the BB ground with any output pin, as this will damage the board. For instance, +the BBB ground with any output pin, as this will damage the board. For instance, if connecting a diode to the output pins, always use a resistor of >1000 Ohm in -parallel. See the configuration page for information on which functionality -specific pins support. +parallel. ## Example with LEDs (BB) To test the system LED functionality of the Julia code from the BBB, open a diff --git a/docs/src/examples/testing.md b/docs/src/examples/testing.md index 98cde17b142f639c26044b01a19970dace0f7165..69d3d2bbf053643b07759628c266704c0a976eae 100644 --- a/docs/src/examples/testing.md +++ b/docs/src/examples/testing.md @@ -1,5 +1,5 @@ -# Tests -The BeagleBone tests can be run on any computer, regrdless of their file-syste. +# Testing +The BeagleBone tests can be run on any computer, regardless of their file-system. By setting the flag RUNNING_TESTS to true, a dummy file-system is exported in which the tests are run operate. This has the advantage of enabling testing of the code run on the BB free from the BB itself, without building the Debian FS, diff --git a/docs/src/index.md b/docs/src/index.md index 0db694bf636b005ad4a9e21ed3ce14eb51e9bda4..d19da74c90f5ef46bfbb6e1e02d2473b98d6ccab 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -5,12 +5,17 @@ CurrentModule = LabConnections ``` ## Getting Started ```@contents -Pages = ["man/introduction.md", "man/installation.md", "man/development.md"] +Pages = ["man/introduction.md", "man/installation.md"] Depth = 1 ``` ## Examples ```@contents -Pages = ["examples/examples.md", "examples/testing.md"] +Pages = ["examples/examples.md"] +Depth = 1 +``` +## Development +```@contents +Pages = ["man/development.md", "examples/testing.md"] Depth = 1 ``` ## Functions diff --git a/docs/src/man/development.md b/docs/src/man/development.md index 3b66de50200c337bc96478e951a5a335c4ab6fdb..0f56758cbf69392ec54b3f16246edaa8e2454726 100644 --- a/docs/src/man/development.md +++ b/docs/src/man/development.md @@ -1,7 +1,6 @@ -## Package Development - -### LabConnections.jl Development +# Package Development +## Development environment 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 @@ -11,4 +10,5 @@ Open a new terminal and navigate to `.julia/dev/LabConnections`, where the packa git checkout julia1 git pull ``` -to ensure that you are working on the correct development branch for Julia v1.0.X. +to ensure that you are working on the correct development branch for Julia v1.0.X. You can now edit the code in `.julia/dev/LabConnections` +and run it using a Julia REPL. When you are satisfied with your changes, simply commit and push the changes in the `.julia/dev/LabConnections` directory to the GitLab server.