From bcbdca105c2abb4fc42b6e5d2a9b1e3e9dab7fac Mon Sep 17 00:00:00 2001
From: Dario Quintero <darioaquintero@gmail.com>
Date: Mon, 17 Jul 2023 15:16:18 +0100
Subject: [PATCH] FEAT: New docs restructure

---
 README.md                              | 72 ++++++++++++++++++++++++++
 README.rst => docs/README.rst          |  2 +-
 docs/examples/04_spice_cosimulation.py |  2 +-
 docs/index.rst                         |  2 +-
 setup.py                               |  2 +-
 5 files changed, 76 insertions(+), 4 deletions(-)
 create mode 100644 README.md
 rename README.rst => docs/README.rst (98%)

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..38fe4efd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,72 @@
+# **P**hotonic **I**ntegrated **EL**ectronics
+
+[![PyPI
+Name](https://img.shields.io/badge/pypi-piel-blue)](https://pypi.python.org/pypi/piel)
+[![PyPI
+Version](https://img.shields.io/pypi/v/piel.svg)](https://pypi.python.org/pypi/piel)
+[![Build
+Status](https://img.shields.io/travis/daquintero/piel.svg)](https://travis-ci.com/daquintero/piel)
+[![Documentation
+Status](https://readthedocs.org/projects/piel/badge/?version=latest)](https://piel.readthedocs.io/en/latest/?version=latest)
+[![MIT](https://img.shields.io/github/license/gdsfactory/gdsfactory)](https://choosealicense.com/licenses/mit/)
+[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Microservices to codesign photonics, electronics, communications,
+quantum, and more.
+
+-   Free software: MIT license
+-   Documentation: <https://piel.readthedocs.io>
+
+## Target functionality
+
+-   Co-simulation and optimisation between integrated photonic and
+    electronic chip design.
+-   System interconnection modelling in multiple domains.
+-   Chip and interposer design integration.
+-   Component models translation library between simulation tools.
+-   Quantum models of physical circuitry.
+
+`piel` aims to provide an integrated workflow to co-design photonics and
+electronics, classically and quantum. It does not aim to replace the
+individual functionality of each design tool, but rather provide a glue
+to easily connect them all together and extract the system performance.
+
+## Examples
+
+Follow the many [examples in the
+documentation](https://piel.readthedocs.io/en/latest/examples.html).
+
+## Microservices Toolset
+
+This package provides interconnection functions to easily co-design
+microelectronics through the functionality of the
+[IIC-OSIC-TOOLS](https://github.com/iic-jku/iic-osic-tools) and
+photonics via [GDSFactory](https://github.com/gdsfactory/gdsfactory).
+
+![image](docs/_static/img/piel_microservice_structure.png)
+
+Some existing microservice dependency integrations are:
+
+-   [cocotb](https://github.com/cocotb/cocotb) - a coroutine based
+    cosimulation library for writing VHDL and Verilog testbenches in
+    Python.
+-   [hdl21](https://github.com/dan-fritchman/Hdl21) - Analog Hardware
+    Description Library in Python
+-   [GDSFactory](https://github.com/gdsfactory/gdsfactory) - An open
+    source platform for end to-end photonic chip design and validation
+-   [OpenLane v1](https://github.com/The-OpenROAD-Project/OpenLane) - an
+    automated RTL to GDSII flow based on several components including
+    OpenROAD, Yosys, Magic, Netgen and custom methodology scripts for
+    design exploration and optimization
+-   [sax](https://github.com/flaport/sax) - S-parameter based frequency
+    domain circuit simulations and optimizations using JAX.
+-   [thewalrus](https://github.com/XanaduAI/thewalrus) -A library for
+    the calculation of hafnians, Hermite polynomials and Gaussian boson
+    sampling.
+-   [qutip](https://github.com/qutip/qutip) - QuTiP: Quantum Toolbox in
+    Python
+
+## Contribution
+
+If you feel dedicated enough to become a project maintainer, or just
+want to do a single contribution, let\'s do this together!
diff --git a/README.rst b/docs/README.rst
similarity index 98%
rename from README.rst
rename to docs/README.rst
index ddb1159b..fa7b0309 100644
--- a/README.rst
+++ b/docs/README.rst
@@ -37,7 +37,7 @@ microelectronics through the functionality of the
 `IIC-OSIC-TOOLS <https://github.com/iic-jku/iic-osic-tools>`__ and
 photonics via `GDSFactory <https://github.com/gdsfactory/gdsfactory>`__.
 
-.. image:: docs/_static/img/piel_microservice_structure.png
+.. image:: _static/img/piel_microservice_structure.png
 
 Some existing microservice dependency integrations are:
 
diff --git a/docs/examples/04_spice_cosimulation.py b/docs/examples/04_spice_cosimulation.py
index d28252f0..a65aecdc 100644
--- a/docs/examples/04_spice_cosimulation.py
+++ b/docs/examples/04_spice_cosimulation.py
@@ -212,7 +212,7 @@
 
 h.netlist(our_resistive_heater_circuit, sys.stdout, fmt="spice")
 
-# ```spice
+# ```
 # * Anonymous `circuit.Package`
 # * Generated by `vlsirtools.SpiceNetlister`
 # *
diff --git a/docs/index.rst b/docs/index.rst
index bb58d9a7..86fe4552 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,6 +1,6 @@
 .. _readme:
 
-.. include:: ../README.rst
+.. include:: README.rst
 
 
 Contents
diff --git a/setup.py b/setup.py
index fe93fded..225b4107 100644
--- a/setup.py
+++ b/setup.py
@@ -4,7 +4,7 @@
 
 from setuptools import setup, find_packages
 
-with open("README.rst") as readme_file:
+with open("README.md") as readme_file:
     readme = readme_file.read()
 
 requirements = [