From bcc50685ca000f79d4dbb46cb185f4262dcd141a Mon Sep 17 00:00:00 2001 From: Windel Bouwman Date: Wed, 6 Jun 2018 22:19:16 +0200 Subject: [PATCH] Add usage to readme --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 00a425c0d..5235ea219 100644 --- a/README.md +++ b/README.md @@ -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.