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 2019-04-12 11:44:03 +10:00 committed by GitHub
parent 16f519d150
commit 8a05b71bb6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -21,23 +21,24 @@ All software files are licenced under GNU GPL v3. https://www.gnu.org/licenses/
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/ 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 # Building from Source
I use Qt Creator to build the software interface. I use Qt Creator to build the software interface.
https://www.qt.io/download-open-source/ https://www.qt.io/download-open-source/
Open Desktop_Interface/Labrador.pro, then Clean All -> Run qmake -> Build All. Open Desktop_Interface/Labrador.pro, then Clean All -> Run qmake -> Build All.
If you're on Linux (including Raspberry Pi), then you can also build the software from source by cloning the repo, cd'ing to the Desktop_Interface directory then running:
If you're on Linux (including Raspberry Pi), then you can also build the software from source by cloning the repo, cd'ing to the Desktop_Interface directory then running:
``` ```
qmake qmake
make make
sudo make install sudo make install
``` ```
Then, to launch, just type `labrador` into the terminal. 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. 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 4.0.
# Known bugs. # Known bugs.
Most of the main bugs have now been fixed, including all synchronisation issues. 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. Please open an issue if you're aware of any in particular.
# Collaboration # Collaboration
@ -49,6 +50,5 @@ For code submissions, look into Pull Requests.
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 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. Thanks to all.
~Chris ~Chris