openbci-archive / OpenBCI_Python

The Python software library designed to work with OpenBCI hardware.
MIT License
506 stars 207 forks source link

Proposition for INSTALL paragraph inside README.md #36

Open crazybaud opened 7 years ago

crazybaud commented 7 years ago

Proposition for INSTALL paragraph inside README.md, it may help a few

# only on Ubuntu, Fedora and macOS are ko in our case (bluepy: Python interface to Bluetooth LE on Linux).
# start your device, start your bluetooth
mkdir ~/my-ganglion-project
cd ~/my-ganglion-project
sudo apt-get install python-pip libglib2.0-dev
pip -V # check if version is in 2.x version
git clone --recursive https://github.com/OpenBCI/OpenBCI_Python
cd ~/my-ganglion-project/OpenBCI_Python/bluepy/bluepy
sudo mkdir /usr/local/lib/python2.7/dist-packages && sudo chmod g+rwx /usr/local/lib/python2.7/dist-packages# we had to do it ... maybe you don't
sudo make
sudo pip install -e ~/my-ganglion-project/OpenBCI_Python/bluepy
cd ~/my-ganglion-project/OpenBCI_Python
sudo pip install -r requirements.txt
hcitool lescan # you can see your device ;)
sudo hciconfig hci1 down # why ? I don't know :p
sudo hciconfig hci1 up
sudo python user.py --board ganglion --add print
jfrey-xx commented 7 years ago

Hello, this is good idea, the Readme would need some reworking and clarifications. However, there are various cases (ganglion or not, linux, mac, windows, etc.), so maybe a dedicated "INSTALL" is even better.

I will mark that as an enhancement, you are welcome to work on it and make a pull request :)