Skip to content

Latest commit

 

History

History
49 lines (36 loc) · 2.15 KB

README.md

File metadata and controls

49 lines (36 loc) · 2.15 KB
Raw

This is a project to write an interpreter and a compiler for a made up language Monkey. The repository follows the book "Writing an Interpreter in Go" until Tag Book1End, and its sequel "Writing a Compiler in Go" until Tag Book2End. All further commits are my own contribution.

How to run

Linux

  1. Clone the repository
  2. Run the command cd MyCode/ to change directories.
  3. To run the REPL, run the command ./build/monkey.
  4. Alternatively, create a file with extension .mky and run the command ./build/monkey [file] to compile and run the file

Windows

  1. Clone the repository
  2. Run the command cd .\MyCode\ to change directories.
  3. To run the REPL, run the command .\build\monkey.
  4. Alternatively, create a file with extension .mky and run the command .\build\monkey [file] to compile and run the file

A pre-written file test.mky is also present in the repository

Running benchmarks

Linux

  1. Clone the repository
  2. Run the command cd MyCode/ to change directories.
  3. Run command .\build\benchmark -engine=vm|eval|[blank] [file-path]
    1. To run using compiler and vm, -engine = vm
    2. To run using interpreter, -engine = eval
    3. To perform comparison between the two, ignore the -engine flag
    4. To perform benchmark testing on a custom file, include the file-path of the file. (Extension = .mky)
    5. Do not specify the file path before the -engine flag

Windows

  1. Clone the repository
  2. Run the command cd .\MyCode\ to change directories.
  3. Run command .\build\benchmark -engine=vm|eval|[blank] [file-path]
    1. To run using compiler and vm, -engine = vm
    2. To run using interpreter, -engine = eval
    3. To perform comparison between the two, ignore the -engine flag
    4. To perform benchmark testing on a custom file, include the file-path of the file. (Extension = .mky)
    5. Do not specify the file path before the -engine flag
  • The default benchmark is based on a pre-written fibonacci recursion program.
  • The fibonacci number can be changed by going into ./benchmark/main.go Ln 30, and editing the number in the function call.