Skip to content

Commit

Permalink
Added images and more details to README
Browse files Browse the repository at this point in the history
  • Loading branch information
ShaunMitchell98 authored Jun 6, 2020
1 parent 682e4b8 commit d3dd50b
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# PyInt

PyInt is a Python Interpreter based on the Clox interpreter by Bob Nystrom from https://craftinginterpreters.com/

![REPL mode](https://github.com/ShaunMitchell98/PyInt/blob/master/Images/REPL.png)

By default, when you run the executable it starts a REPL, where you can run code quickly. By passing arguements, you can get additional output such as the executed bytecode and the state of the stack.

![REPL with Executed Bytecode](https://github.com/ShaunMitchell98/PyInt/blob/master/Images/REPL%20with%20Execution%20Output.png)

The output doesn't have to be to the terminal, output can be redirected to a file by replacing t with f and adding the file path as the next input, for example:

![Execution Output to File](https://github.com/ShaunMitchell98/PyInt/blob/master/Images/REPL%20with%20Execution%20Output%20to%20File(1).png)
![](https://github.com/ShaunMitchell98/PyInt/blob/master/Images/REPL%20with%20Execution%20Output%20to%20File(2).png)

As well as writing commands in the terminal, you can run a file using the arguement -fi and passing the filepath:

![File Input](https://github.com/ShaunMitchell98/PyInt/blob/master/Images/Text%20File%20Input(1).png)
![](https://github.com/ShaunMitchell98/PyInt/blob/master/Images/Text%20File%20Input(2).png)

0 comments on commit d3dd50b

Please sign in to comment.