mirror of
https://github.com/hazemKrimi/jack-compiler.git
synced 2026-05-01 17:48:57 +00:00
38 lines
842 B
Markdown
38 lines
842 B
Markdown
# Jack Compiler
|
|
|
|
This is a compiler made as an assignment for the [Nand To Tetris Course: Part 2](https://nand2tetris.org/project10).
|
|
|
|
## Requirements
|
|
|
|
You need Go to develop, build, and run this project.
|
|
|
|
## Installation
|
|
|
|
1. Clone this repo:
|
|
|
|
```
|
|
git clone https://github.com/hazemKrimi/jack-compiler
|
|
```
|
|
|
|
2. To run this against Jack files, run the following command with the path of the `.jack` file (or directory):
|
|
|
|
```
|
|
./out/jack-compiler <path_to_jack_file_or_directory>
|
|
```
|
|
|
|
The result `.vm` file will be written in the same location as the source file.
|
|
|
|
## Build
|
|
|
|
To build this project run the following command:
|
|
|
|
```
|
|
go build -o out
|
|
```
|
|
|
|
You will find the executable in the `out` directory.
|
|
|
|
## Testing
|
|
|
|
You can download Jack files to test the compiler against from the [Nand To Tetris website](https://www.nand2tetris.org/software).
|