Skip to content

Commit d60b0bd

Browse files
committed
Update documentation
1 parent 0a6d544 commit d60b0bd

File tree

2 files changed

+22
-29
lines changed

2 files changed

+22
-29
lines changed

LICENSE

+13-11
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Everything else:
55
In countries where it's respected, everything is released into the
66
public domain; otherwise it's released under the following terms:
77

8-
Copyright (c) 2010-2012, Cody Brocious, Kyle Machulis/Nonpolynomial Labs
8+
Copyright (c) 2010-2016, Cody Brocious, The OpenYou Organization
99

1010
All rights reserved.
1111

@@ -19,13 +19,15 @@ modification, are permitted provided that the following conditions are met:
1919
* The names of its contributors may not be used to endorse or promote products
2020
derived from this software without specific prior written permission.
2121

22-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
23-
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24-
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25-
DISCLAIMED. IN NO EVENT SHALL Cody Brocious BE LIABLE FOR ANY
26-
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27-
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28-
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
29-
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30-
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31-
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Cody
26+
Brocious/The OpenYou Organization BE LIABLE FOR ANY DIRECT, INDIRECT,
27+
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28+
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
29+
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30+
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
31+
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
32+
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
33+
DAMAGE.

README.md

+9-18
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,14 @@ data from the Emotiv EPOC headset. Note that this will not give you
2020
processed data (i.e. anything available in the Emo Suites in the
2121
software), just the raw sensor data.
2222

23-
The C library is backed by hidapi, and should work on any platform
24-
that hidapi also works on.
23+
C Library
24+
=========
25+
26+
Please note that the python and C libraries are now in different
27+
repos. If you would like to use the C version of emokit, the repo
28+
is at
29+
30+
http://www.github.com/openyou/emokit-c
2531

2632
Information
2733
===========
@@ -67,21 +73,9 @@ Linux / OS X
6773
* pyhidapi - https://github.com/NF6X/pyhidapi
6874

6975

70-
C Language
71-
----------
72-
73-
* CMake - http://www.cmake.org
74-
* libmcrypt - https://sourceforge.net/projects/mcrypt/
75-
* hidapi - http://www.signal11.us/oss/hidapi/
76-
7776
Usage
7877
=====
7978

80-
C library
81-
---------
82-
83-
See emokitd.c example
84-
8579
Python library
8680
--------------
8781

@@ -130,13 +124,10 @@ To fix that re-comiple your kernel with /dev/hidraw support
130124

131125
OS X
132126
----
133-
Recent OS versions no longer allow usb devices to become unclaimed by the kernel.
134-
You must use a HIDAPI library.
135127

136128
The render.py file uses pygame, visit http://pygame.org/wiki/MacCompile
137129
Do not export the architecture compiler flags for recent 64bit versions of OS X.
138130

139-
140131
Credits - Cody
141132
==============
142133

@@ -187,4 +178,4 @@ Suites? Saddest hotel EVER.
187178
X Reading: 0 Quality: 0
188179
O2 Reading: 337 Quality: 0
189180
O1 Reading: -198 Quality: 0
190-
AF3 Reading: 146 Quality: 0
181+
AF3 Reading: 146 Quality: 0

0 commit comments

Comments
 (0)