This is an automated email from the ASF dual-hosted git repository.
jiacai2050 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/horaedb-docs.git
The following commit(s) were added to refs/heads/main by this push:
new 8368f0d feat: add sdk dev guide (#131)
8368f0d is described below
commit 8368f0d75ea2b5cf306ac3b4c6fc7a5beb0eba4e
Author: Jiacai Liu <[email protected]>
AuthorDate: Wed Jun 19 16:44:32 2024 +0800
feat: add sdk dev guide (#131)
---
docs/src/en/SUMMARY.md | 1 +
docs/src/en/dev/sdk_develop.md | 48 ++++++++++++++++++++++++++++++++++++++++++
2 files changed, 49 insertions(+)
diff --git a/docs/src/en/SUMMARY.md b/docs/src/en/SUMMARY.md
index 81f6acb..28e1988 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 0000000..8d851e4
--- /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
+```
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
