First crack at updating the readme (#1106)

* First crack at updating the readme
Goals
Include up front example
Simplify
Get users to things quicker
Move complicated details to wiki.

* headers were not working,
intellij and github don't use same render for .md files

* Fix verb agreement

* Add a fir filter diagram
Compact the fir-filter code a bit

* More compact filter

* Additional README.md updates

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

* Don't use chisel-lang.org, drop HCL

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

* Fix link to fir image, make it relative

* Proposed readme changes

* Resize picture, restyle doc bullets

1 files changed, 126 insertions, 0 deletions

diff --git a/doc/images/fir_filter.svg b/doc/images/fir_filter.svg
new file mode 100644
index 00000000..c2627b88
--- /dev/null
+++ b/doc/images/fir_filter.svg
@@ -0,0 +1,126 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg xmlns="http://www.w3.org/2000/svg" version="1.1" viewBox="0 0 1244 500" width="1244pt" height="500pt" >
+    <metadata> Produced by OmniGraffle 6.6.2 </metadata>
+    <defs>
+        <marker orient="auto" id="FilledArrow_Marker" viewBox="-1 -3 6 6" markerWidth="6" markerHeight="6" color="black">
+            <g>
+                <path d="M 3.7333333 0 L 0 -1.4 L 0 1.4 Z" fill="currentColor" stroke="currentColor" stroke-width="1" />
+            </g>
+        </marker>
+        <font-face font-family="Helvetica Neue" font-size="48" panose-1="2 0 5 3 0 0 0 2 0 4" units-per-em="1000" underline-position="-100" underline-thickness="50" slope="0" x-height="517" cap-height="714" ascent="951.99585" descent="-212.99744" font-weight="500">
+            <font-face-src>
+                <font-face-name name="HelveticaNeue" />
+            </font-face-src>
+        </font-face>
+    </defs>
+    <g stroke="none" stroke-opacity="1" stroke-dasharray="none" fill="none" fill-opacity="1">
+        <title>Canvas 1</title>
+        <rect fill="white" width="1244" height="500" />
+        <g>
+            <title>Layer 1</title>
+            <path d="M 366.41973 71.517452 L 366.41973 74.028804 L 453.03527 74.028804 L 457.03527 74.028804" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <path d="M 568.78883 75.048743 L 577.78883 75.048743 L 709.71162 74.72518" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <line x1="135.836195" y1="74.72518" x2="254.8946" y2="74.72518" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <text transform="translate(27.5 47.39712)" fill="black">
+                <tspan font-family="Helvetica Neue" font-size="48" font-weight="500" fill="black" x="11.2349865" y="46" textLength="60.384">x[i]</tspan>
+            </text>
+            <ellipse cx="203.20098" cy="228.63232" rx="46.42706" ry="46.199477" fill="white" />
+            <ellipse cx="203.20098" cy="228.63232" rx="46.42706" ry="46.199477" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <line x1="228.73582" y1="250.33302" x2="177.66614" y2="206.93161" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="4" />
+            <line x1="177.66614" y1="250.33302" x2="225.64069" y2="206.93161" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="4" />
+            <path d="M 203.65628 74.72518 L 203.65628 94.62518 L 203.34209 161.03309 L 203.34209 165.03309" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <ellipse cx="424.90863" cy="404.27043" rx="46.42706" ry="46.199477" fill="white" />
+            <ellipse cx="424.90863" cy="404.27043" rx="46.42706" ry="46.199477" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <line x1="392.30372" y1="404.7256" x2="457.51355" y2="403.81526" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="4" />
+            <line x1="424.59592" y1="371.9536" x2="424.45347" y2="436.58725" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="4" />
+            <ellipse cx="424.90863" cy="228.63232" rx="46.42706" ry="46.199477" fill="white" />
+            <ellipse cx="424.90863" cy="228.63232" rx="46.42706" ry="46.199477" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <line x1="450.44348" y1="250.33302" x2="399.3738" y2="206.93161" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="4" />
+            <line x1="399.3738" y1="250.33302" x2="447.34834" y2="206.93161" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="4" />
+            <path d="M 425.36394 75.22518 L 425.0502 161.0331 L 425.0502 165.0331" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <ellipse cx="640.38857" cy="228.63232" rx="46.42706" ry="46.199477" fill="white" />
+            <ellipse cx="640.38857" cy="228.63232" rx="46.42706" ry="46.199477" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <line x1="665.9234" y1="250.33302" x2="614.85373" y2="206.93161" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="4" />
+            <line x1="614.85373" y1="250.33302" x2="662.8283" y2="206.93161" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="4" />
+            <path d="M 640.84387 75.22518 L 640.53014 161.0331 L 640.53014 165.0331" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <path d="M 199.27175 408.97866 L 199.27175 405.27027 L 357.0921 405.27027 L 361.0921 405.27027" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <path d="M 551.4035 229.10905 L 572.56225 228.88908 L 576.56225 228.88908" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <path d="M 203.11996 276.33167 L 203.11996 285.33167 L 202.90096 396.27027 L 202.90096 405.27027" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <path d="M 424.90865 276.33174 L 424.90865 296.23174 L 424.90865 336.671 L 424.90865 340.671" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <ellipse cx="640.38857" cy="404.27043" rx="46.42706" ry="46.199477" fill="white" />
+            <ellipse cx="640.38857" cy="404.27043" rx="46.42706" ry="46.199477" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <line x1="607.78365" y1="404.7256" x2="672.9935" y2="403.81526" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="4" />
+            <line x1="640.07585" y1="371.9536" x2="639.9334" y2="436.58725" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="4" />
+            <path d="M 472.83564 404.27044 L 492.73564 404.27044 L 572.56156 404.27044 L 576.56156 404.27044" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <path d="M 640.38858 276.33174 L 640.38858 296.23174 L 640.38858 336.671 L 640.38858 340.671" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <text transform="translate(36.148164 198.16206)" fill="black">
+                <tspan font-family="Helvetica Neue" font-size="48" font-weight="500" x="13.8509865" y="46" textLength="55.152">b0</tspan>
+            </text>
+            <path d="M 124.00214 223.85307 L 124.00214 225.74543 L 135.4613 225.74543 L 139.4613 225.74543" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <text transform="translate(272.29226 199.96032)" fill="black">
+                <tspan font-family="Helvetica Neue" font-size="48" font-weight="500" x="8.231933" y="46" textLength="55.152">b1</tspan>
+            </text>
+            <line x1="348.90813" y1="227.97792" x2="359.58736" y2="227.97792" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <text transform="translate(479.43486 201.78098)" fill="black">
+                <tspan font-family="Helvetica Neue" font-size="48" font-weight="500" x="13.8509865" y="46" textLength="55.152">b2</tspan>
+            </text>
+            <path d="M 796.46527 74.357994 L 796.46527 75.31301 L 837.1002 75.31301 L 841.1002 75.31301" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <path d="M 950.354 74.443145 L 959.354 74.443145 L 994 74.443145 L 994 86.64128 L 994 95.64128" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <ellipse cx="993.45715" cy="228.63232" rx="46.42706" ry="46.199477" fill="white" />
+            <ellipse cx="993.45715" cy="228.63232" rx="46.42706" ry="46.199477" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <line x1="1018.992" y1="250.33302" x2="967.9223" y2="206.93161" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="4" />
+            <line x1="967.9223" y1="250.33302" x2="1015.89686" y2="206.93161" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="4" />
+            <path d="M 994 95.64128 L 993.65185 161.03328 L 993.65185 165.03328" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <path d="M 904.4721 229.10905 L 925.63083 228.88908 L 929.63083 228.88908" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <ellipse cx="993.45715" cy="404.27043" rx="46.42706" ry="46.199477" fill="white" />
+            <ellipse cx="993.45715" cy="404.27043" rx="46.42706" ry="46.199477" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <line x1="960.85223" y1="404.7256" x2="1026.06206" y2="403.81526" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="4" />
+            <line x1="993.1444" y1="371.9536" x2="993.002" y2="436.58725" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="4" />
+            <path d="M 836.33776 405.42267 L 836.33776 404.6219 L 925.63143 404.6219 L 929.63143 404.6219" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <path d="M 993.45716 276.33174 L 993.45716 296.23174 L 993.45716 336.671 L 993.45716 340.671" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <text transform="translate(829.50343 201.78098)" fill="black">
+                <tspan font-family="Helvetica Neue" font-size="48" font-weight="500" x="13.8509865" y="46" textLength="55.152">bn</tspan>
+            </text>
+            <path d="M 742.1183 24 C 752 45 710.25415 108.238393 719.91286 135.991255 C 729.57157 163.74412 771.6187 313.77478 773.3229 341.94451 C 775.0271 370.11425 736.7309 456.89843 745.0041 475.60808" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <path d="M 796 28.5 C 802 45 768.37938 107.65991 778.0381 135.41277 C 787.6968 163.16563 829.7439 313.1963 831.4481 341.36603 C 833.1523 369.53577 794.8561 456.31995 803.1293 475.0296" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <text transform="translate(717.5 32.144827)" fill="black">
+                <tspan font-family="Helvetica Neue" font-size="48" font-weight="500" x="17.426986" y="46" textLength="48">…</tspan>
+            </text>
+            <text transform="translate(732.81513 186.14483)" fill="black">
+                <tspan font-family="Helvetica Neue" font-size="48" font-weight="500" x="17.426986" y="46" textLength="48">…</tspan>
+            </text>
+            <text transform="translate(747.1183 361.71585)" fill="black">
+                <tspan font-family="Helvetica Neue" font-size="48" font-weight="500" x="17.426986" y="46" textLength="48">…</tspan>
+            </text>
+            <line x1="686.81556" y1="403.81526" x2="729.0054" y2="404.01856" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <text transform="translate(1126.5 370.59843)" fill="black">
+                <tspan font-family="Helvetica Neue" font-size="48" font-weight="500" x="16.24" y="46" textLength="59.52">y[i]</tspan>
+            </text>
+            <line x1="1039.88413" y1="403.77043" x2="1105.6" y2="403.71805" marker-end="url(#FilledArrow_Marker)" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <rect x="270.56576" y="43.752294" width="92.853973" height="64.633648" fill="white" />
+            <rect x="270.56576" y="43.752294" width="92.853973" height="64.633648" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <text transform="translate(275.56576 47.39712)" fill="black">
+                <tspan font-family="Helvetica Neue" font-size="48" font-weight="500" fill="black" x="26.762986" y="46" textLength="29.328">Z</tspan>
+            </text>
+            <text transform="translate(306 46.900785)" fill="#262626">
+                <tspan font-family="Helvetica Neue" font-size="34" font-weight="500" fill="#262626" x="31.515986" y="32" textLength="19.822">⁻¹</tspan>
+            </text>
+            <rect x="474.43486" y="42.84196" width="92.853973" height="64.633648" fill="white" />
+            <rect x="474.43486" y="42.84196" width="92.853973" height="64.633648" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <text transform="translate(479.43486 46.486787)" fill="black">
+                <tspan font-family="Helvetica Neue" font-size="48" font-weight="500" x="26.762986" y="46" textLength="29.328">Z</tspan>
+            </text>
+            <text transform="translate(539.7954 45.908905)" fill="#262626">
+                <tspan font-family="Helvetica Neue" font-size="34" font-weight="500" fill="#262626" x=".8357103" y="32" textLength="19.822">⁻¹</tspan>
+            </text>
+            <rect x="858.5" y="43.752294" width="92.853973" height="64.633648" fill="white" />
+            <rect x="858.5" y="43.752294" width="92.853973" height="64.633648" stroke="black" stroke-linecap="round" stroke-linejoin="round" stroke-width="3" />
+            <text transform="translate(863.5 47.39712)" fill="black">
+                <tspan font-family="Helvetica Neue" font-size="48" font-weight="500" x="26.762986" y="46" textLength="29.328">Z</tspan>
+            </text>
+            <text transform="translate(923.86055 46.819238)" fill="#262626">
+                <tspan font-family="Helvetica Neue" font-size="34" font-weight="500" fill="#262626" x=".8357103" y="32" textLength="19.822">⁻¹</tspan>
+            </text>
+        </g>
+    </g>
+</svg>
\ No newline at end of file