Skip to content

Commit b8239a9

Browse files
committed
Add goals to the README.
1 parent 0a8fd72 commit b8239a9

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,23 @@ A Python virtual machine, written in Rust.
1010
* useable as a library
1111
* a fine-grained sandbox
1212

13+
## Goals
14+
15+
* Compatible with CPython's bytecode from 3.4 to 3.6, in order to take advantage of [FAT Python](https://faster-cpython.readthedocs.org/fat_python.html)
16+
* Support CPython's implementation of the standard library
17+
* No crash, even when messing with code objects
18+
* Bytecode optimizations at runtime
19+
* Less bounded by the GIL than CPython
20+
21+
## Dependencies
22+
23+
* CPython 3.4 (used as a parser and bytecode compiler). Versions newer than 3.4 should work, but their support is not tested.
24+
* [Rust](https://www.rust-lang.org/downloads.html)
25+
* [Cargo](https://crates.io/install)
26+
1327
## Try it
1428

15-
1. Install Python 3.4 (used as a parser and bytecode compiler), git, [Rust](https://www.rust-lang.org/downloads.html) and [Cargo](https://crates.io/install)
16-
2. `git clone https://github.com/ProgVal/pythonvm-rust.git`
17-
3. `cd pythonvm-rust`
18-
4. `python3 -m compileall -b pythonlib examples`
19-
5. `cargo run pythonlib/ examples/helloworld.pyc`
29+
1. `git clone https://github.com/ProgVal/pythonvm-rust.git`
30+
2. `cd pythonvm-rust`
31+
3. `python3 -m compileall -b pythonlib examples`
32+
4. `cargo run pythonlib/ examples/helloworld.pyc`

0 commit comments

Comments
 (0)