Merge pull request #15 from ucb-bar/readme

Update README with Mem(seqRead) -> SeqMem()

1 files changed, 15 insertions, 0 deletions

diff --git a/README.md b/README.md
index 12423672..3fe2130b 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,21 @@ modifications are:
    val wire = Wire(Bits(width = 15))
    ```
 
+ - Sequential memories:
+   ```
+   val addr = Reg(UInt())
+   val mem = Mem(UInt(width=8), 1024, seqRead = true)
+   val dout = when(enable) { mem(addr) }
+   ```
+   becomes (in Chisel3):
+   ```
+   val addr = UInt()
+   val mem = SeqMem(1024, UInt(width=8))
+   val dout = mem.read(addr, enable)
+   ```
+   Notice the address register is now internal to the SeqMem(), but the data
+   will still return on the subsequent cycle. 
+  
 ## Getting Started
 
 ### Overview