mirror of https://github.com/status-im/go-waku.git
fix: readme (#221)
This commit is contained in:
parent
15f3abec3a
commit
36d4be451a
2
Makefile
2
Makefile
|
@ -89,7 +89,6 @@ build-example-c-bindings:
|
||||||
build-example: build-example-basic2 build-example-chat-2 build-example-filter2 build-example-c-bindings
|
build-example: build-example-basic2 build-example-chat-2 build-example-filter2 build-example-c-bindings
|
||||||
|
|
||||||
static-library: ##@cross-compile Build go-waku as static library for current platform
|
static-library: ##@cross-compile Build go-waku as static library for current platform
|
||||||
mkdir -p ./build/lib
|
|
||||||
@echo "Building static library..."
|
@echo "Building static library..."
|
||||||
go build \
|
go build \
|
||||||
-buildmode=c-archive \
|
-buildmode=c-archive \
|
||||||
|
@ -99,7 +98,6 @@ static-library: ##@cross-compile Build go-waku as static library for current pla
|
||||||
@ls -la ./build/lib/libgowaku.*
|
@ls -la ./build/lib/libgowaku.*
|
||||||
|
|
||||||
dynamic-library: ##@cross-compile Build status-go as shared library for current platform
|
dynamic-library: ##@cross-compile Build status-go as shared library for current platform
|
||||||
mkdir -p ./build/lib
|
|
||||||
@echo "Building shared library..."
|
@echo "Building shared library..."
|
||||||
$(GOBIN_SHARED_LIB_CFLAGS) $(GOBIN_SHARED_LIB_CGO_LDFLAGS) go build \
|
$(GOBIN_SHARED_LIB_CFLAGS) $(GOBIN_SHARED_LIB_CGO_LDFLAGS) go build \
|
||||||
-buildmode=c-shared \
|
-buildmode=c-shared \
|
||||||
|
|
16
README.md
16
README.md
|
@ -29,6 +29,15 @@ docker build -t go-waku:latest .
|
||||||
docker run go-waku:latest --help
|
docker run go-waku:latest --help
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Building on windows
|
||||||
|
|
||||||
|
Windows requires the following tools to be installed
|
||||||
|
- git bash (which is installed as part of [Git](https://git-scm.com/downloads))
|
||||||
|
- [chocolatey](https://chocolatey.org/install)
|
||||||
|
- [make](https://community.chocolatey.org/packages/make)
|
||||||
|
- [mingw](https://community.chocolatey.org/packages/mingw)
|
||||||
|
- [go](https://go.dev/doc/install)
|
||||||
|
|
||||||
## Library
|
## Library
|
||||||
```
|
```
|
||||||
go get github.com/status-im/go-waku
|
go get github.com/status-im/go-waku
|
||||||
|
@ -86,6 +95,13 @@ To enable the git hooks:
|
||||||
git config core.hooksPath hooks
|
git config core.hooksPath hooks
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Bugs, Questions & Features
|
||||||
|
|
||||||
|
If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/status-im/go-waku/issues/new/).
|
||||||
|
|
||||||
|
For more general discussion, help and latest news, join **#go-waku** on [Vac Discord](https://discord.com/channels/864066763682218004/865466710924460034) or [Telegram](https://t.me/vacp2p).
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
Licensed and distributed under either of
|
Licensed and distributed under either of
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue