diff --git a/docs/src/en/SUMMARY.md b/docs/src/en/SUMMARY.md index 81f6acb7..28e1988e 100644 --- a/docs/src/en/SUMMARY.md +++ b/docs/src/en/SUMMARY.md @@ -48,6 +48,7 @@ - [Supported Platform](dev/platform.md) - [Compile and Running](dev/compile_run.md) - [Profile](dev/profiling.md) +- [SDK Development](dev/sdk_develop.md) - [Conventional Commit](dev/conventional_commit.md) - [Style guide](dev/style_guide.md) - [Roadmap](dev/roadmap.md) diff --git a/docs/src/en/dev/sdk_develop.md b/docs/src/en/dev/sdk_develop.md new file mode 100644 index 00000000..8d851e43 --- /dev/null +++ b/docs/src/en/dev/sdk_develop.md @@ -0,0 +1,48 @@ +# Rust + +```bash +git clone https://github.com/apache/horaedb-client-rs + +cargo build +``` + +# Python + +## Requirements + +- python 3.7+ + +The Python SDK rely on Rust SDK, so [cargo](https://doc.rust-lang.org/stable/cargo/getting-started/installation.html) is also required, then install build tool [maturin](https://github.com/PyO3/maturin): + +```bash +pip install maturin +``` + +Then we can build Python SDK: + +```bash +git clone https://github.com/apache/horaedb-client-py + +maturin build +``` + +# Go + +```bash +git clone https://github.com/apache/horaedb-client-go + +go build ./... +``` + +# Java + +## Requirements + +- java 1.8 +- maven 3.6.3+ + +```bash +git clone https://github.com/apache/horaedb-client-java + +mvn clean install -DskipTests=true -Dmaven.javadoc.skip=true -B -V +```