Skip to content

Commit 90bce69

Browse files
authored
Update doc "how to build from source" (#111)
1 parent 9119b66 commit 90bce69

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ Most of the contributions that we receive are code contributions, but you can al
2020
* If you're unable to find an issue addressing the problem, [open a new one](https://github.com/apache/skywalking/issues/new).
2121
Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not happening.
2222

23+
## Compiling and building
24+
25+
Check [here](docs/FAQ.md#q-how-to-build-from-sources).
26+
2327
## Add a new feature or enhance an existing one
2428

2529
_Before making any significant changes, please [open an issue](https://github.com/apache/skywalking/issues)._

docs/FAQ.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,15 @@ you can also disable the plugins via environment variables `SW_AGENT_DISABLE_PLU
1414

1515
#### Q: How to build from sources?
1616

17-
#### A: If you want to build the SkyWalking Python Agent from source codes, for some reasons, for example, you want to try the latest features that're not released yet, please clone the source codes from GitHub and `make install` it:
17+
#### A: Download the source tar from [the official website](http://skywalking.apache.org/downloads/), and run the following commands to build from source
18+
19+
```shell
20+
$ tar -zxf skywalking-python-src-<version>.tgz
21+
$ cd skywalking-python-src-<version>
22+
$ make install
23+
```
24+
25+
If you want to build from the latest source codes from GitHub, for some reasons, for example, you want to try the latest features that are not released yet, please clone the source codes from GitHub and `make install` it:
1826

1927
```shell
2028
git clone https://github.com/apache/skywalking-python
@@ -23,4 +31,4 @@ git submodule update --init
2331
make install
2432
```
2533

26-
**NOTE** that because we use Git submodule, the aforementioned commands don't apply if you download the source codes (`.tgz`) from our official website.
34+
**NOTE** that only releases from [the website](http://skywalking.apache.org/downloads/) are official Apache releases.

0 commit comments

Comments
 (0)