bump version

1 files changed, 23 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8df7cf8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Booth Multiplier
+
+Sequentially multiply two signed twos-compliment integers in
+Verilog using the [Booth Algorithm][1].
+
+[1]: https://en.wikipedia.org/wiki/Booth%27s_multiplication_algorithm
+
+## License
+
+All source code is licensed under the CERN-OHL-W v2 or later.
+
+## Usage
+
+Set parameters `A1_LEN` and `A2_LEN` to the argument size of the
+first and second integer. Set `A2LEN_SIZ` equal to
+`floor(log2(A2_LEN) + 1)`.
+
+After inputting each integer, pulse `arm` and wait until `fin` goes
+high to retreive the output in `outn`.
+
+## Simulating
+
+Simulation is done with Verilator. Run `make`.