Skip to content

Commit bcc5068

Browse files
committed
Add usage to readme
1 parent 1edbfd8 commit bcc5068

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
# RustPython
2-
A Python Interpreter written in Rust
2+
A Python Interpreter written in Rust :snake: :scream: :metal:.
3+
4+
# Usage
5+
6+
To test RustPython, do the following:
7+
8+
git clone https://github.com/RustPython/RustPython
9+
cd RustPython
10+
cargo run my_script.py
11+
12+
Or use pip to install extra modules:
13+
14+
cargo run -m pip install requests
315

416
# Code organization
17+
518
The files in the top level directory are from [windelbouwman/rspython][rspython] which contains an implementation of the parser and vm in `src/`
619

720
An alternative implementation of python virtual machine that are compatible with CPython parser are from [shinglyu/RustPython][rustpython] and is located in the `VM/` folder.

0 commit comments

Comments
 (0)