diff --git a/.gitignore b/.gitignore index 7480a1a..3dac6ce 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ out hack-assembler build +.cache diff --git a/CMakeLists.txt b/CMakeLists.txt index 141fe58..2c6f197 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,5 +1,5 @@ cmake_minimum_required(VERSION 3.18) -set(NAME "hack-assembly") +set(NAME "hack-assembler") project(${NAME} CXX) set(CMAKE_CXX_STANDARD 17) diff --git a/README.md b/README.md index 1706ddc..f238978 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # hack-assembler -An implementation of a hack assembler in C++. +An implementation of a hack assembler in C++, based on the project 6 of the [nand2tetris course](https://www.nand2tetris.org/https://b1391bd6-da3d-477d-8c01-38cdf774495a.filesusr.com/ugd/44046b_89a8e226476741a3b7c5204575b8a0b2.pdf). ## Compilation @@ -12,9 +12,15 @@ cmake --build build ## Usage ```bash -g++ -o hack-assembler main.cpp cat | ./hack-assembler > ./out/ ``` +## Testing + +In order to check the assembler, you can generate the .hack files from the asm-samples directory. And test those within [nand2tetris CPU emulator](https://nand2tetris.github.io/web-ide/cpu/). + +## References +- [nand2tetris course](https://www.nand2tetris.org/) + ## License This project is under the WTFPL License. See [LICENSE](LICENSE) for details.