Cleanup the project

* Add .cache to gitignore (for the nlohmann::json library)
* Fix the project name
* Update the readme
This commit is contained in:
2026-06-03 10:13:05 +02:00
parent 214b3e4d9e
commit 4afdcd1660
3 changed files with 10 additions and 3 deletions

View File

@@ -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 <input_file.asm> | ./hack-assembler > ./out/<output_file.hack>
```
## 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.