Skip to content

Update doc "how to build from source" #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kezhenxu94 merged 3 commits into from
Dec 25, 2020
Merged

Update doc "how to build from source" #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4714000
Update doc "how to build from source"
kezhenxu94 Dec 25, 2020
a1938f5
Update doc "how to build from source"
kezhenxu94 Dec 25, 2020
fe87500
Add link to compiling and building
kezhenxu94 Dec 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ Most of the contributions that we receive are code contributions, but you can al
* If you're unable to find an issue addressing the problem, [open a new one](https://github.com/apache/skywalking/issues/new).
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.

## Compiling and building

Check [here](docs/FAQ.md#q-how-to-build-from-sources).

## Add a new feature or enhance an existing one

_Before making any significant changes, please [open an issue](https://github.com/apache/skywalking/issues)._
Expand Down
12 changes: 10 additions & 2 deletions docs/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,15 @@ you can also disable the plugins via environment variables `SW_AGENT_DISABLE_PLU

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

#### 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:
#### A: Download the source tar from [the official website](http://skywalking.apache.org/downloads/), and run the following commands to build from source
Comment thread
kezhenxu94 marked this conversation as resolved.

```shell
$ tar -zxf skywalking-python-src-<version>.tgz
$ cd skywalking-python-src-<version>
$ make install
```

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:

```shell
git clone https://github.com/apache/skywalking-python
Expand All @@ -23,4 +31,4 @@ git submodule update --init
make install
```

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