Add usage to readme

This commit is contained in:
Windel Bouwman
2018-06-06 22:19:16 +02:00
parent 1edbfd80f3
commit bcc50685ca

View File

@@ -1,7 +1,20 @@
# RustPython
A Python Interpreter written in Rust
A Python Interpreter written in Rust :snake: :scream: :metal:.
# Usage
To test RustPython, do the following:
git clone https://github.com/RustPython/RustPython
cd RustPython
cargo run my_script.py
Or use pip to install extra modules:
cargo run -m pip install requests
# Code organization
The files in the top level directory are from [windelbouwman/rspython][rspython] which contains an implementation of the parser and vm in `src/`
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.