Skip to content

Commit 5d7af22

Browse files
authored
Add requirement of "mx" for virtual environment
Add link for "mx" and explanation of adding to PATH (copied snippet from GraalVM's README.md). Fix typos and grammar in some places.
1 parent 94bad7e commit 5d7af22

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,17 @@ some examples of what you can do with it, check out the
1515
[reference](https://www.graalvm.org/docs/reference-manual/languages/python/).
1616

1717
### Create a virtual environment
18+
#### Requirements:
19+
---
20+
* [mx](https://github.com/graalvm/mx) - a separate Python tool co-developed for GraalVM development. This tool must be downloaded and put onto your PATH:
1821

22+
```
23+
git clone https://github.com/graalvm/mx.git
24+
export PATH=$PWD/mx:$PATH
25+
```
26+
---
1927
The best way of using the GraalVM implementation of Python is out of a virtual environment. This generates
20-
wrapper scripts and makes the implementation usable from shell as standard Python interpreter. To do so
28+
wrapper scripts and makes the implementation usable from shell as a standard Python interpreter. To do so
2129
execute the following command in the project directory:
2230

2331
```
@@ -30,11 +38,11 @@ To activate the environment in your shell session call:
3038
source <dir-to-venv>/bin/activate
3139
```
3240

33-
In the venv multiple executables are available, like `python`, `python3` and `graalpython`.
41+
In the venv, multiple executables are available, like `python`, `python3` and `graalpython`.
3442

3543
### Installing packages
3644

37-
At the moment not enough of the standard library is implemented to run the
45+
Currently, not enough of the standard library is implemented to run the
3846
standard package installers for many packages. As a convenience, we provide a
3947
simple module to install packages that we know to be working (including
4048
potential patches required for those packages). Try the following to find out
@@ -61,7 +69,7 @@ some other extensions might also already work, but we're not actively testing
6169
other extensions right now and cannot promise anything. Note that to try
6270
extensions on this implementation, you have to download, build, and install them
6371
manually for now. To do so, we recommend LLVM 6. Other versions might also work,
64-
but this version is what we're testing with in our CI.
72+
but this version of LLVM is what we're testing with in our CI.
6573

6674
### Polyglot Usage
6775

@@ -70,7 +78,7 @@ cross-language interop. This will hopefully give you an idea how to use it.
7078

7179
### Contributing
7280

73-
I you're thinking about contributing something to this repository, you will need
81+
If you're thinking about contributing something to this repository, you will need
7482
to sign the [Oracle Contributor
7583
Agreement](http://www.graalvm.org/community/contributors/) for us to able to
7684
merge your work. Please also take note of our [code of

0 commit comments

Comments
 (0)