Doc update

This commit is contained in:
ycc
2023-11-06 22:44:21 +01:00
parent cd41a59518
commit 08ff9d58b8
12 changed files with 855 additions and 732 deletions

View File

@ -1,14 +1,21 @@
# MEOW lib
## Go Mobile setup
go install golang.org/x/mobile/cmd/gobind@latest
go install golang.org/x/mobile/cmd/gomobile@latest
go get golang.org/x/mobile/bind
Replace "Get" by "get" in messages.pb.go
# Documentation generation
## required tools
* protoc
* protoc-gen-doc
* protoc-gen-uml
* go-plantuml
* plantuml (plantuml command is as shell script : `java -jar /<path-to-plantuml>/plantuml-mit-<version>.jar "$@"`)
## generation
run the shell scripts
gomobile bind -target android -androidapi=19
cd pb
./protogen.sh
cd doc
./docgen.sh
# Tests
Look at the exported API and cry...
## Other option
GOOS=android GOARCH=arm64 go build -buildmode=c-archive -o libmeow.a