docs: cleanup readme + add some comments to code#16

samlaf merged 1 commit intoseismicSeismicSystems/seismic-compilers:seismicfrom

docs--cleanup-readme-and-minimize-diff-with-upstreamSeismicSystems/seismic-compilers:docs--cleanup-readme-and-minimize-diff-with-upstreamCopy head branch name to clipboard