feat: initial releaseHEADmain

1 files changed, 19 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9765dbd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Icarus Verilog Test-bench
+
+## Dependencies
+
+- [Icarus Verilog](https://steveicarus.github.io/iverilog/)
+- [GTKWave](https://github.com/gtkwave/gtkwave) (Optional)
+
+## Usage
+
+```shell
+make # Build all
+
+make test # Build all and run test-bench
+
+# Build all, run test-bench, and open test waveform in GTKWave
+make test && gtkwave ./wave.vcd
+
+make clean # Clean all build artifacts
+```