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 2018-02-06 15:02:33 +11:00 committed by GitHub
parent 43ab98bec1
commit 8eb24f4f05
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -15,7 +15,7 @@ All hardware files (schematics, PCB) are licenced under Creative Commons 4.0 (CC
The intention is to move to a less restrictive licence in future, where commercial hardware derivatives are allowed but the use of the Labrador name or any branding is not. If anyone knows how to implement such a licence, I'm all ears.
# Documentation and Binary
# Documentation and Software
To download binary (executable) versions of the software, go to:
https://github.com/espotek/labrador/releases
@ -25,15 +25,14 @@ For the documentation, please visit:
https://github.com/espotek/labrador/wiki
# Build Instructions
# Building from Source
I use Qt Creator to build the software interface.
https://www.qt.io/download-open-source/
Open Desktop Interface/Labrador.pro, then Clean All -> Run qmake -> Build All.
Others have built it through qmake and the terminal, though (I have no idea how, specifically).
Just make sure you have Qt 5.6 or later.
For the AVR software, I use Atmel Studio 7. Just load up the .atsln and push F7.
Again, you can use avr-gcc if you don't want to install a full IDE.
For the AVR software, I use Atmel Studio 7. Just load up the .atsln and push F7. Again, you can use avr-gcc if you don't want to install a full IDE.
The PCB files were designed in KiCAD 4.0.
@ -43,9 +42,13 @@ Please open an issue if you're aware of any in particular.
# 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. Or you can open an issue. I'm not picky. :)
If you just want to say hello and remind me that people are actually using my product, please email admin@espotek.com
# Cleanup Notice
Please note that this repository was cleaned up on 21/10/17.
This significantly reduced the size - from over 200MB to about 3MB, but I was fairly aggressive and it's possible that something was deleted that shouldn't have been.