Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
philippitts committed Sep 22, 2023
1 parent 2b2fe7c commit 91082ff
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:

Expand All @@ -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/<Build Configuration>` 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.

0 comments on commit 91082ff

Please sign in to comment.