mirrors
/
Labrador
mirror of https://github.com/EspoTek/Labrador.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Chris Esposito 2021-08-18 13:31:18 +10:00 committed by GitHub
parent 2665f1dc91
commit 8b77cd44bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -6,11 +6,6 @@ http://espotek.com/labrador
This repo hosts all of the software and hardware that makes Labrador possible.
# Getting Started
If you're new to Labrador or oscilloscopes in general, I strongly recommend checking out the fantastic tutorial series produced by Lief Koepsel:
https://www.wellys.com/posts/courses_electronics/
It features well-written, rich articles as well as video content that explains everything more clearly than I ever could!
# Documentation and Software
To download binary (executable) versions of the software, go to:
https://github.com/espotek/labrador/releases
@ -20,18 +15,24 @@ The software is re-built automatically each time I make a change to the source c
For the documentation, please visit:
https://github.com/espotek/labrador/wiki
# Getting Started
If you're new to Labrador or oscilloscopes in general, I strongly recommend checking out the fantastic tutorial series produced by Lief Koepsel:
https://www.wellys.com/posts/courses_electronics/
It features well-written, rich articles as well as video content that explains everything more clearly than I ever could!
# Raspberry Pi Build
***Please note that the Raspbian version 9 (Stretch) or later is required to install this software.***
To install Labrador on the Raspberry Pi, open a terminal and paste the following command:
`wget -O /tmp/labrador_bootstrap_pi https://raw.githubusercontent.com/EspoTek/Labrador/master/labrador_bootstrap_pi && sudo chmod +x /tmp/labrador_bootstrap_pi && sudo /tmp/labrador_bootstrap_pi`
This will automatically download, compile and installs the latest version of the Labrador software from source. After running it, a desktop entry will appear for the Labrador software (under Education), and running the `labrador` command from the terminal will launch the software interface.
# Additional Extras
There are community contributed 3D printable cases available at Thingiverse, courtesy of SpaceBex and Bostwickenator:
* https://www.thingiverse.com/thing:3188243
* https://www.thingiverse.com/thing:4705392
# Licence
All Dekstop software files are licenced under GNU GPL v3. https://www.gnu.org/licenses/gpl.html
All Microcontroller software files, with the exception of those provided by Atmel, are licenced under the 3-Clause BSD License. https://opensource.org/licenses/BSD-3-Clause
All hardware files (schematics, PCB) are licenced under Creative Commons 4.0 (CC BY-NC-SA). https://creativecommons.org/licenses/by-nc-sa/4.0/
# Building from Source
I use Qt Creator to build the software interface.
https://www.qt.io/download-open-source/
@ -47,19 +48,17 @@ Then, to launch, just type `labrador` into the terminal.
To build the AVR software, I use Atmel Studio 7. Just load up the .atsln and push F7. You can use `avr-gcc` if you don't want to install a full IDE.
The PCB files can be edited in KiCAD 4.0.
The PCB files can be edited in KiCAD 5.0 or later.
# Known bugs
Most of the main bugs from the pre-launch period have now been fixed, including synchronisation issues.
Please open an issue if you're aware of any in particular.
# Licence
All Dekstop software files are licenced under GNU GPL v3. https://www.gnu.org/licenses/gpl.html
All Microcontroller software files, with the exception of those provided by Atmel, are licenced under the 3-Clause BSD License. https://opensource.org/licenses/BSD-3-Clause
All hardware files (schematics, PCB) are licenced under Creative Commons 4.0 (CC BY-NC-SA). https://creativecommons.org/licenses/by-nc-sa/4.0/
# Collaboration
If you want to make any suggestions, or better yet, submit some code, please do so here at GitHub.
Suggestions and feature requests belong on the "Issues" page.
For code submissions, look into Pull Requests.
If you want to submit a Pull Request, bug report or feature request please feel free to do so here at GitHub.
If you just want to say hello and remind me that people are actually using my product (or if you just don't want to make a GitHub account), please email admin@espotek.com
Thanks to all.