Add how-to-build docs (#172)

SkyAPM · Mar 27, 2019 · 67dcdc1 · 67dcdc1
1 parent 98f84fd
commit 67dcdc1
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/docs/guides/how-to-build.md b/docs/guides/how-to-build.md
@@ -0,0 +1,16 @@
+# How to build project
+This document helps people to compile and build the project.
+
+## Build Project
+**Because we are using Git submodule, we recommend don't use `GitHub` tag or release page to download source codes for compiling.**
+
+### Build from GitHub
+- Prepare git and .NET Core SDK.
+- `git clone https://github.com/SkyAPM/SkyAPM-dotnet.git`
+- `cd SkyAPM-dotnet/`
+- Switch to the tag by using `git checkout [tagname]` (Optional, switch if want to build a release from source codes)
+- `git submodule init`
+- `git submodule update`
+- Run `dotnet restore`
+- Run `dotnet build src/SkyApm.Transport.Grpc.Protocol`
+- Run `dotnet build skyapm-dotnet.sln`
diff --git a/docs/skyapm_config.md → docs/guides/skyapm_config.md b/docs/skyapm_config.md → docs/guides/skyapm_config.md
diff --git a/docs/skyapm_config_cn.md → docs/guides/skyapm_config_cn.md b/docs/skyapm_config_cn.md → docs/guides/skyapm_config_cn.md