diff --git a/README.md b/README.md index ecdd3c25..2a67927f 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,12 @@ Welcome to the GitHub page for the EspoTek Labrador! +# What is it? +The EspoTek Labrador is an open-source board that converts your PC, Raspberry Pi or Android Smartphone and into a full-featured electronics lab bench, complete with oscilloscope, signal generator and more. + +More information available at: http://espotek.com/labrador -https://www.crowdsupply.com/espotek/labrador - -# Build Instructions -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. - -The PCB files were done in KiCAD 4.0. - -# Documentation and Binary -All documentation and binary files are currently hosted here: -https://drive.google.com/drive/u/0/folders/0B7U0ulRLHf8cRVBkeFc2SHpUOGs +This repo hosts all of the software and hardware that makes Labrador possible. # Licence All software files are licenced under GNU GPL v3. https://www.gnu.org/licenses/gpl.html @@ -27,14 +15,39 @@ 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 Software +To download binary (executable) versions of the software, go to: + +https://github.com/espotek/labrador/releases + +For the documentation, please visit: + +https://github.com/espotek/labrador/wiki + + +# 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. + +The PCB files were designed in KiCAD 4.0. + # Known bugs. Most of the main bugs have now been fixed, including all synchronisation issues. -Please open an issue or email me at admin@espotek.com if you're aware of any in particular. +Please open an issue if you're aware of any in particular. # Collaboration -Mailing list is here and open to all who wish to collaborate on the project: -https://groups.google.com/forum/#!forum/labrador-devel -Or you can just use GitHub's issues. :) +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.