diff --git a/README.md b/README.md index 0847585..22828f9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,15 @@ # OpenBCI GUI Helpers -Helpers for [OpenBCI GUI](https://github.com/OpenBCI/OpenBCI_GUI) +Helpers for the [OpenBCI GUI](https://github.com/OpenBCI/OpenBCI_GUI) -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. +These libraries provide utilities for native functions required by the OpenBCI GUI application. This includes support for: + +* Native BLE discovery +* BLED112 Bluetooth discovery + +# Usage + +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. When updating this library in the GUI, use the following folder structure: @@ -15,6 +22,22 @@ When updating this library in the GUI, use the following folder structure: - `libGanglionNativeScan.dylib` - `libGanglionScan.dylib` -## License: +# Building + +## Dependencies + +- [CMake](https://cmake.org/) +- [Maven](https://maven.apache.org/) + +## Build Process + +- [Run CMake](https://cmake.org/runningcmake/) using the `CMakeLists.txt` configuration at the root of the repository to build the native libraries. +- Navigate to the `java-package/openbci_gui_helpers` directory. +- Run `mvn package` + +Libraries will be built in the `compiled/` directory. +The .jar file will be built in the `java-package/openbci_gui_helpers/target` directory. + +# Examples -MIT +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. \ No newline at end of file