Cleaning up README
This should be the basic structure of the README.
Keep it short and sweet, only the absolute essentials. Then use links to jump off to other resources like docs.
-# Silicon Compiler Collection (SCC)
+# SiliconCompiler
![CI Tests](https://github.com/zeroasiccorp/siliconcompiler/workflows/CI%20Tests/badge.svg)
-## Introduction
+SiliconCompiler is an open source Python based hardware compiler framework, that aims to fully automate translation of high level source code into hardware ready for manufacturing.
-* schema.py defines the silicon compiler architecture
-* core.py defines the python user API for accessing the schema
-* setup.py defines a set of pre-configured targets for FPGAs and ASICs
-* cli.py is the command line silicon compiler
+## Resources
-## Pre-Requisites
+- **Website:** https://www.siliconcompiler.com
+- **Documentation:** https://www.siliconcompiler.com/docs
+- **Community:** https://www.siliconcompiler.com/community
-* verilator: front end parsing
-* yosys: synthesis
-* openroad: netlist to GDSII
-* klayout : general gui, file conversion
+## Installation
+```sh
+$ git clone https://github.com/siliconcompiler/siliconcompiler
+$ cd siliconcompiler
+$ pip install -r requirements.txt
+$ python -m pip install -e .
+```
-Python3 libraries (`pip3 install -r requirements.txt`):
-* numpy: linear algebra
-* matploblib: graphing / SVG processing
-* ply: generic lexer / parser
+## Pre-requisites
+The default SiliconCompiler flow depends on a number of open source projects. Full installation support of these tools is out of scope of for the project, Ubuntu based install scripts can be found in the [./setup](setup) directory for convencience.
+- **OpenRoad:** https://github.com/The-OpenROAD-Project/OpenROAD
+- **ABC**: https://github.com/berkeley-abc/abc
+- **Yosys:** https://github.com/YosysHQ/yosys
+- **Verilator:** https://github.com/verilator/verilator
+- **Klayout:** https://github.com/KLayout/klayout
+- **VTR:** https://github.com/verilog-to-routing/vtr-verilog-to-routing
-## Local Installation
-Python installation will depend on your environment. The example below is based on running python3 and pipenv
+## Testing installation
+```bash
+$ ./examples/gcd/run.sh
+$ ./examples/gcd/run_remote.sh
```
-git clone https://github.com/zeroasiccorp/siliconcompiler
-cd siliconcompiler
-python3 -m pip install -e .
+This will produce a GDSII output at `build/gcd/job1/export/outputs/gcd.gds`, which can then be viewed in KLayout.
-```
+## Write your first SiliconCompiler program
-## Examples
+```sh
+$ python
+```
-To build the GCD example circuit using SiliconCompiler, run:
-```bash
->> ./examples/gcd/run.sh
+```python
+>>> import siliconcompiler
+>>> chip = siliconcompiler.Chip()
+>>> chip.add('source', 'examples/gcd/gcd.v')
+>>> chip.add('constraint', 'examples/gcd/gcd.sdc')
+>>> chip.set('design', 'gcd')
+>>> chip.set('target', 'freepdk45_asic')
+>>> chip.set('asic', 'diesize', "0 0 100.13 100.8")
+>>> chip.set('asic', 'coresize', "10.07 11.2 90.25 91")
+>>> chip.target()
+>>> chip.run()
+>>> chip.summary()
+>>> chip.display()
```
+## Continuous build status
+(place holder)
+
+## Contributing
+(place holder)
+
+## License
+TBD
+
+
-This will produce a GDSII output at `build/gcd/job1/export/outputs/gcd.gds`,
-which can then be viewed in KLayout.
