Skip to content

Commit 91082ff

Browse files
committed
Update README
1 parent 2b2fe7c commit 91082ff

1 file changed

Lines changed: 27 additions & 4 deletions

File tree

README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
# OpenBCI GUI Helpers
22

3-
Helpers for [OpenBCI GUI](https://github.com/OpenBCI/OpenBCI_GUI)
3+
Helpers for the [OpenBCI GUI](https://github.com/OpenBCI/OpenBCI_GUI)
44

5-
Built using Github Actions for all OS. The .dylib files for Mac are also provided as an artifact. These files should be included in the `libraries` folder outside of the .jar file as shown below. As a result, we do not need to extract them from the .jar file on Mac.
5+
These libraries provide utilities for native functions required by the OpenBCI GUI application. This includes support for:
6+
7+
* Native BLE discovery
8+
* BLED112 Bluetooth discovery
9+
10+
# Usage
11+
12+
These files should be included in the `libraries` folder outside of the .jar file as shown below. Note that the .dylib files should be included outside of the .jar file so that they do not need to be extracted on MacOS systems.
613

714
When updating this library in the GUI, use the following folder structure:
815

@@ -15,6 +22,22 @@ When updating this library in the GUI, use the following folder structure:
1522
- `libGanglionNativeScan.dylib`
1623
- `libGanglionScan.dylib`
1724

18-
## License:
25+
# Building
26+
27+
## Dependencies
28+
29+
- [CMake](https://cmake.org/)
30+
- [Maven](https://maven.apache.org/)
31+
32+
## Build Process
33+
34+
- [Run CMake](https://cmake.org/runningcmake/) using the `CMakeLists.txt` configuration at the root of the repository to build the native libraries.
35+
- Navigate to the `java-package/openbci_gui_helpers` directory.
36+
- Run `mvn package`
37+
38+
Libraries will be built in the `compiled/<Build Configuration>` directory.
39+
The .jar file will be built in the `java-package/openbci_gui_helpers/target` directory.
40+
41+
# Examples
1942

20-
MIT
43+
There are several examples that can be used to test the features supported in the project. These examples are located in the `java-package/openbci_gui_helpers/src/main/java/openbci_gui_helpers/examples` directory.

0 commit comments

Comments
 (0)