logos-messaging-go-bindings/README.md

# Waku Go Bindings

Go bindings for the Waku library.

## Install

```
go get -u github.com/logos-messaging/logos-messaging-go-bindings
```

## Building & Dependencies

`libwaku` (from `logos-messaging-nim`) is required at compile-time.

### Building with Makefile

If you have `logos-messaging-nim` checked out, point the build to it:

```bash
# path to your existing logos-messaging-nim clone
export LMN_DIR=/absolute/path/to/logos-messaging-nim
export CGO_CFLAGS="-I${LMN_DIR}/library"
export CGO_LDFLAGS="-L${LMN_DIR}/build -lwaku -Wl,-rpath,${LMN_DIR}/build"

# compile all packages
make -C waku build

# run all tests
make -C waku test

# run a specific test
make -C waku test TEST=TestConnectedPeersInfo
```

## Development

When working on this repository itself, `logos-messaging-nim` is included as a git submodule for convenience.

- Initialize and update the submodule, then build `libwaku`
    ```sh
    git submodule update --init --recursive
    make -C waku build-libwaku
    ```
- Build the project. Submodule paths are used by default to find `libwaku`.
    ```shell
    make -C waku build
    ```