Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added usage section
  • Loading branch information
John-Ling authored Jul 24, 2023
1 parent 8fc8999 commit 8f2d451
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# A Basic Compiler For Pseudocode

My implementation of a fully functional compiler to make the IGCSE / A Level Computer Science language Pseuedocode executable on any machine. The compiler consists of a hand-built lexer, parser and code generator (glossing over details for brevity). Code generation creates valid Python code for users to study and find relationships between pseudocode and Python.
My implementation of a fully functional compiler to make the IGCSE / A Level Computer Science language Pseuedocode executable on any machine. The compiler consists of a hand-built lexer, parser and code generator. Code generation creates valid Python code for users to study and find relationships between pseudocode and Python.

Should this project succeed, I hope it can help people who really struggled to learn the pseudocode syntax like I did.
I hope it can help people who really struggled to learn the pseudocode syntax like I did.

## Usage
1. Download binary for either Linux or Windows
2. Run using command ./ppc \[your_file.pcode]
3. Output file will be your_file.py
4. (Optional) Add downloaded binary to your path if you want to run ppc from anywhere

Example pseudocode files can be found in the data folder. Have fun and try writing your own!

0 comments on commit 8f2d451

Please sign in to comment.