Update README.md

This commit is contained in:
Chris Esposito 2018-07-19 19:55:19 +10:00 committed by GitHub
parent a0a17e904f
commit 35917d0716
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 13 deletions

View File

@ -25,13 +25,18 @@ All hardware files (schematics, PCB) are licenced under Creative Commons 4.0 (CC
# 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.
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:
```
qmake
make
sudo make install
```
Then, to launch, just type "labrador" into the terminal.
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.
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 were designed in KiCAD 4.0.
The PCB files can be edited in KiCAD 4.0.
# Known bugs.
Most of the main bugs have now been fixed, including all synchronisation issues.
@ -46,14 +51,6 @@ For code submissions, look into Pull Requests. Or you can open an issue. I'm n
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.
For this reason, the old, unclean repo has been preserved at:
https://github.com/EspoTek/Labrador_backup
Thanks to all.
~Chris