Labrador/README.md

Welcome to the GitHub page for the EspoTek Labrador!

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

# Licence
All software files are licenced under GNU GPL v3.  https://www.gnu.org/licenses/gpl.html

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/

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.

# 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.

# 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.  :)

# 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
Update README.md 2017-10-21 07:32:38 +01:00			`Welcome to the GitHub page for the EspoTek Labrador!`
Cleaned junk out of repo. Still need to edit history Former-commit-id: e2061432d4b3d2bbb1f9621f3cce34d43b682b2a Former-commit-id: aeeed8aa2af692f92b7ea7ec8cc042d49c679ce5 2017-10-21 06:11:49 +01:00
			`http://espotek.com/labrador`

			`https://www.crowdsupply.com/espotek/labrador`

Added Build Instructions. 2017-10-21 07:38:13 +01:00			`# Build Instructions`
			`I use Qt Creator to build the software interface.`
Update README.md 2017-11-28 00:19:50 +00:00			`https://www.qt.io/download-open-source/`
Added Build Instructions. 2017-10-21 07:38:13 +01:00			`Open Desktop Interface/Labrador.pro, then Clean All -> Run qmake -> Build All.`
Update README.md 2017-11-28 00:19:50 +00:00			`Others have built it through qmake and the terminal, though (I have no idea how, specifically).`
Added Build Instructions. 2017-10-21 07:38:13 +01:00			`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.`

Cleaned junk out of repo. Still need to edit history Former-commit-id: e2061432d4b3d2bbb1f9621f3cce34d43b682b2a Former-commit-id: aeeed8aa2af692f92b7ea7ec8cc042d49c679ce5 2017-10-21 06:11:49 +01:00			`# Documentation and Binary`
			`All documentation and binary files are currently hosted here:`
			`https://drive.google.com/drive/u/0/folders/0B7U0ulRLHf8cRVBkeFc2SHpUOGs`

			`# Licence`
			`All software files are licenced under GNU GPL v3. https://www.gnu.org/licenses/gpl.html`

			`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/`

			`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.`

			`# Known bugs.`
			`Most of the main bugs have now been fixed, including all synchronisation issues.`
Update README.md 2017-10-21 07:32:38 +01:00			`Please open an issue or email me at admin@espotek.com if you're aware of any in particular.`
Cleaned junk out of repo. Still need to edit history Former-commit-id: e2061432d4b3d2bbb1f9621f3cce34d43b682b2a Former-commit-id: aeeed8aa2af692f92b7ea7ec8cc042d49c679ce5 2017-10-21 06:11:49 +01:00
			`# Collaboration`
			`Mailing list is here and open to all who wish to collaborate on the project:`
			`https://groups.google.com/forum/#!forum/labrador-devel`
Update README.md 2017-10-21 07:32:38 +01:00			`Or you can just use GitHub's issues. :)`

			`# 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`

Cleaned junk out of repo. Still need to edit history Former-commit-id: e2061432d4b3d2bbb1f9621f3cce34d43b682b2a Former-commit-id: aeeed8aa2af692f92b7ea7ec8cc042d49c679ce5 2017-10-21 06:11:49 +01:00
			`Thanks to all.`

			`~Chris`