Skip to content

Commit 34a6223

Browse files
committed
[GR-35627] GitHub PR #93
PullRequest: graalpython/2067
2 parents 9fed5e0 + 089379f commit 34a6223

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,27 @@ To try GraalPython with a full GraalVM, including the support for Java embedding
2020
and interop with other languages, you can use the bundled releases from
2121
[www.graalvm.org](https://www.graalvm.org/downloads/).
2222

23-
If you want to build GraalPython from source, checkout this repository and the
24-
[mx](https://github.com/graalvm/mx) build tool, and run `mx --dy /compiler
25-
python-gvm` in the `graalpython` repository root. If the build is fine, it will
26-
print the full path to the `graalpython` executable as the last line of output.
23+
### Building from source
24+
#### Requirements
25+
26+
* [mx](https://github.com/graalvm/mx) - a separate Python tool co-developed for GraalVM development. This tool must be
27+
downloaded and put onto your PATH:
28+
```
29+
git clone https://github.com/graalvm/mx.git
30+
export PATH=$PWD/mx:$PATH
31+
```
32+
33+
#### Building
34+
35+
Run `mx --dy /compiler python-gvm` in the `graalpython` repository root. If the build is fine, it will print the full
36+
path to the `graalpython` executable as the last line of output.
2737

2838
For more information and some examples of what you can do with GraalPython,
2939
check out the [reference](https://www.graalvm.org/reference-manual/python/).
3040

3141
### Create a virtual environment
32-
33-
The best way of using the GraalVM implementation of Python is out of a virtual
34-
environment. To create the venv, run the following:
42+
The best way of using the GraalVM implementation of Python is out of a virtual environment. To do so
43+
execute the following command in the project directory:
3544

3645
```
3746
graalpython -m venv <dir-to-venv>
@@ -43,12 +52,11 @@ To activate the environment in your shell session call:
4352
source <dir-to-venv>/bin/activate
4453
```
4554

46-
In the venv multiple executables are available, like `python`, `python3` and `graalpython`.
47-
55+
In the venv, multiple executables are available, like `python`, `python3` and `graalpython`.
4856

4957
### Installing packages
5058

51-
At the moment not enough of the standard library is implemented to run the
59+
Currently, not enough of the standard library is implemented to run the
5260
standard package installers for many packages. As a convenience, we provide a
5361
simple module to install packages that we know to be working (including
5462
potential patches required for those packages). Try the following to find out
@@ -89,7 +97,7 @@ Python 3.8+. We describe the current status of the compatibility mode
8997

9098
### Contributing
9199

92-
I you're thinking about contributing something to this repository, you will need
100+
If you're thinking about contributing something to this repository, you will need
93101
to sign the [Oracle Contributor
94102
Agreement](http://www.graalvm.org/community/contributors/) for us to able to
95103
merge your work. Please also take note of our [code of
@@ -108,3 +116,4 @@ Permissive License v 1.0 as shown at
108116
implementation is in part derived from and contains additional code from 3rd
109117
parties, the copyrights and licensing of which is detailed in the
110118
[LICENSE](LICENSE) and [THIRD_PARTY_LICENSE](THIRD_PARTY_LICENSE.txt) files.
119+

0 commit comments

Comments
 (0)