https://github.com/pupil-labs/pupil
Raw File
Tip revision: 106735f6dfe2222dca0201054647dbc889e519af authored by Moritz Kassner on 24 February 2014, 12:39:03 UTC
adding more help strings to various dials and knobs
Tip revision: 106735f
README.md
# Pupil
Open source eye tracking hardware and software platform that started as a thesis project at MIT. Pupil is a project in active, community driven development. The hardware is accessible, hackable, and affordable. The software is open source and written in `Python` and `C` when speed is an issue.

Our vision is to create tools for a diverse group of people interested in learning about eye tracking and conducting their eye tracking projects.

##Project Website
For an intro to the Pupil mobile eye tracking platform have a look at the [Pupil Labs Website](http://pupil-labs.com "Pupil Labs").

## Get Started
<table>
<tr>
	<td><a href="https://github.com/pupil-labs/pupil/wiki/Getting-Pupil-Hardware">Getting Pupil Hardware</a></td>
	<td><a href="https://github.com/pupil-labs/pupil/wiki/Community">Community</a></td>
	<td><a href="https://github.com/pupil-labs/pupil/wiki/Setup">Setup</a></td>
	<td><a href="https://github.com/pupil-labs/pupil/wiki/User-Guide">User Guide</a></td>
	<td><a href="https://github.com/pupil-labs/pupil/wiki/Developer-Guide">Developer Guide</a></td>
</tr>
<tr>
	<td align="center"><img width="80" src="https://raw.github.com/wiki/pupil-labs/pupil/media/icons/Pupil_Logo_wiki-01.png" /></td>
	<td  align="center"><img width="80" src="https://raw.github.com/wiki/pupil-labs/pupil/media/icons/Pupil_Logo_wiki-02.png" /></td>
	<td align="center"><img width="80" src="https://raw.github.com/wiki/pupil-labs/pupil/media/icons/Pupil_Logo_wiki-03.png" /></td>
	<td align="center"><img width="80" src="https://raw.github.com/wiki/pupil-labs/pupil/media/icons/Pupil_Logo_wiki-04.png" /></td>
	<td align="center"><img width="80" src="https://raw.github.com/wiki/pupil-labs/pupil/media/icons/Pupil_Logo_wiki-05.png" /></td>
</tr>
<tr>
	<td>How and where to get Pupil mobile eye tracking headset</td>
	<td>How to contribute & get in touch with users and devs</td>
	<td>Links to download bundles and instructions to build from source</td>
	<td>How to calibrate, make recordings, and visualize data</td>
	<td>Resources for Pupil developers</td>
</tr>
</table>


## License
All source code written by Pupil Labs is open source for noncommercial uses as specified the [CC BY-NC-SA license](http://creativecommons.org/licenses/by-nc-sa/3.0/ "CC BY-NC-SA license"). We want you to change and improve the code -- make a fork!  Just make sure to credit us and share your work with the Pupil community.  See the wiki for more info on the [license](https://github.com/pupil-labs/pupil/wiki/License "License").  For commercial use and licencing [contact us!](https://github.com/pupil-labs/pupil/wiki/Community#email "email us")

___

 [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/pupil-labs/pupil/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
back to top