Skip to content

Commit 9bf3fb0

Browse files
Update README.md
Fixed formatting.
1 parent b33ff44 commit 9bf3fb0

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

README.md

+19-15
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# Flic SDK for Linux Beta
22

33
## Whats included
4-
* daemon - This is the central daemon that manages all buttons. Run it with ./daemon -l -f flic.sqlite3
5-
* fliclib-cpp/flic - This is a command line tool for managing the daemon. Type help to see available commands
6-
* fliclib-cpp/flic.hph - These are the header files for the C++ client library
7-
* fliclib-cpp/libflic.a - This is the C++ client library
8-
* fliclib-cpp/ffi/java/flic.jar - Java bindings for the Flic client library
9-
* fliclib-cpp/ffi/java/libflicjava.so - Flic JNI library. The sample code expects this to be copied to /usr/lib/libflicjava.so
10-
* fliclib-cpp/ffi/python/flic/dist/flic-0.1-py2.7.egg - Python2.7 bindings for the Flic client library. Install with sudo easy_install flic-0.1-py2.7.egg
11-
* fliclib-cpp/ffi/samples/java/Main.java - Sample Java code. Run with java -cp "../../java/flic.jar:." Main
12-
* fliclib-cpp/ffi/samples/java/Makefile - Makefile for the Java sample
13-
* fliclib-cpp/ffi/samples/python/main.py - Sample Python2.7 code. Run with python2 main.py
4+
* `daemon` - This is the central daemon that manages all buttons. Run it with `./daemon -l -f flic.sqlite3`
5+
* `fliclib-cpp/flic` - This is a command line tool for managing the daemon. Type `help` to see available commands
6+
* `fliclib-cpp/flic.hph` - These are the header files for the C++ client library
7+
* `fliclib-cpp/libflic.a` - This is the C++ client library
8+
* `fliclib-cpp/ffi/java/flic.jar` - Java bindings for the Flic client library
9+
* `fliclib-cpp/ffi/java/libflicjava.so` - Flic JNI library. The sample code expects this to be copied to `/usr/lib/libflicjava.so`
10+
* `fliclib-cpp/ffi/python/flic/dist/flic-0.1-py2.7.egg` - Python2.7 bindings for the Flic client library. Install with `sudo easy_install flic-0.1-py2.7.egg`
11+
* `fliclib-cpp/ffi/samples/java/Main.java` - Sample Java code. Run with `java -cp "../../java/flic.jar:." Main`
12+
* `fliclib-cpp/ffi/samples/java/Makefile` - `Makefile` for the Java sample
13+
* `fliclib-cpp/ffi/samples/python/main.py` - Sample Python2.7 code. Run with `python2 main.py`
1414

1515
## Supported platforms
16-
Binaries and libraries has been compiled for x86_64, i386 and armv6l. All code has been compiled and tested on Ubuntu 15.10 for desktop and Raspbian Jessy. This means it should be compatible with desktop systems and both raspberrypi 1 & 2.
16+
Binaries and libraries has been compiled for `x86_64`, `i386` and `armv6l`. All code has been compiled and tested on Ubuntu 15.10 for desktop and Raspbian Jessy. This means it should be compatible with desktop systems and both raspberrypi 1 & 2.
1717
## Bluetooth controllers
1818
We haven't tested compability with common Bluetooth controllers. The following devices has been tested and confirmed:
1919
* Plugable USB Bluetooth 4.0 Low Energy Micro Adapter
@@ -22,6 +22,7 @@ We haven't tested compability with common Bluetooth controllers. The following d
2222
### Bluez
2323
Flic requires the latest bluez HEAD to work well
2424
### Building
25+
```
2526
git clone git://git.kernel.org/pub/scm/bluetooth/bluez.git
2627
2728
cd bluez
@@ -33,18 +34,21 @@ cd bluez
3334
make
3435
3536
sudo make install
37+
```
3638

3739
### Running
3840
The easiest way to get started is to run bluetoothd directly from the src folder. Be sure to disable any other bluetoothd service.
3941

42+
```
4043
cd src
4144
sudo ./bluetoothd -nEd
45+
```
4246

4347
## Example
44-
In one terminal run ./bluetoothd -nEd
48+
In one terminal run `./bluetoothd -nEd`
4549

46-
In another terminal run ./daemon -l -f flic.sqlite3
50+
In another terminal run `./daemon -l -f flic.sqlite3`
4751

48-
In a third terminal run ./flic
52+
In a third terminal run `./flic`
4953

50-
In the third terminal enter the command 'startScan'. Now press your Flic button and wait for it to appear. When it does, enter the command 'stopScan'. Hold your Flic button for 8 seconds to make it public, and make sure that it glows read. Then enter the command 'connect MAC' where MAC is the address that appeared during scan. The button should now connect and you will see click events appear.
54+
In the third terminal enter the command `startScan`. Now press your Flic button and wait for it to appear. When it does, enter the command `stopScan`. Hold your Flic button for 8 seconds to make it public, and make sure that it glows read. Then enter the command `connect <MAC>` where MAC is the address that appeared during scan. The button should now connect and you will see click events appear.

0 commit comments

Comments
 (0)