Skip to content
Snippets Groups Projects
Commit 8aed4a9b authored by Marcus Thelander Andrén's avatar Marcus Thelander Andrén
Browse files

Added development to docs

parent 48ea3661
Branches
No related tags found
No related merge requests found
Pipeline #707 failed
......@@ -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>
......
<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
......
......@@ -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>
......
<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.
# 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
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
......
# 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,
......
......@@ -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
......
## 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.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment