commit d2783b18a398c8af7b64409be684f31fb66dac27
author Staf Verhaegen <staf@fibraservi.eu> Sun Mar 20 19:39:00 2022 +0100
committer Staf Verhaegen <staf@fibraservi.eu> Sun Mar 20 19:39:00 2022 +0100
tree 277fd0ad55626bd3bbd84d4a0cad043d9a83e881
parent ca4be4847098fe3c2d336259873e01aa1e364b6c

README

Start of README.

README.md

diff --git a/README.md b/README.md
index d7d53a3..cd7f023 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,16 @@
-# Caravel Analog User
+# PDKMaster based memory compiler test chip
 
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![CI](https://github.com/efabless/caravel_user_project_analog/actions/workflows/user_project_ci.yml/badge.svg)](https://github.com/efabless/caravel_user_project_analog/actions/workflows/user_project_ci.yml) [![Caravan Build](https://github.com/efabless/caravel_user_project_analog/actions/workflows/caravan_build.yml/badge.svg)](https://github.com/efabless/caravel_user_project_analog/actions/workflows/caravan_build.yml)
+TBD
 
----
+## Source
 
-| :exclamation: Important Note            |
-|-----------------------------------------|
+The top level is fully generated from python code in the `doitcode` subdirectory. pydoit is used to generate the desig with the provided `dodo.py` file in the top directory. The code depends on some external modules that are assumed to be installed:
 
-## Please fill in your project documentation in this README.md file 
+* [PDKMaster](https://gitlab.com/Chips4Makers/PDKMaster): python framework (under heavy development) to ease generation of circuits and corresponding DRC compliant layout. This based on a description of a technology with python souce code to allow easy porting to different technologies.
+* [c4m-flexcell](https://gitlab.com/Chips4Makers/c4m-flexcell): a (currently minimal) standard cell library based on PDKMaster
+* [c4m-flexmem](https://gitlab.com/Chips4Makers/c4m-flexmem): the source for the memory compiler
+* [c4m-pdk-sky130](https://gitlab.com/Chips4Makers/c4m-pdk-sky130): the source for the PDKMaster based PDK for the Sky130 technology.
 
+## License
 
-:warning: | Use this sample project for analog user projects. 
-:---: | :---
-
----
-
-Refer to [README](docs/source/index.rst) for this sample project documentation. 
+The resulting GDS files is released under [the LGPL 2.1 or later](https://spdx.org/licenses/LGPL-2.1-or-later.html) license. Some of the source code to generate the GDS is under [the GPL 2.0 or later](https://spdx.org/licenses/GPL-2.0-or-later.html) license.