Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gadfort committed Nov 6, 2023
1 parent c1e8577 commit ecfc8b5
Show file tree
Hide file tree
Showing 4 changed files with 102 additions and 3 deletions.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,20 @@ Utilize the same python environment as SiliconCompiler.
python3 scgallery/rules.py -cfg <cfg> -rules <rules> -check # Check if run met the rule requirements.
python3 scgallery/rules.py -cfg <cfg> -rules <rules> -update # Update rules based on last run.

# To add a design:
# Contributing

## To add a design:
1. Create a folder with the design name (\<design\>) in scgallery/designs
2. add source files to scgallery/designs/\<design\>/src
3. add constraints to scgallery/designs/\<design\>/constraints (using the name of the library it is associated with)
4. create scgallery/designs/\<design\>/\<design\>.py
5. add the design to [scgallery/designs/\_\_init\_\_.py](scgallery/designs/__init__.py)

# Issues / Bugs

We use [GitHub Issues](https://github.com/siliconcompiler/scgallery/issues)
for tracking requests and bugs.

# License

[Apache License 2.0](LICENSE)
88 changes: 88 additions & 0 deletions docs/designs.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,43 @@
designs package
=================

AES
---------

.. automodule:: scgallery.designs.aes.aes

Ariane
---------

.. automodule:: scgallery.designs.ariane.ariane

Black Parrot
------------

.. automodule:: scgallery.designs.black_parrot.black_parrot

Caliptra
---------

.. automodule:: scgallery.designs.caliptra.datavault
.. automodule:: scgallery.designs.caliptra.keyvault
.. automodule:: scgallery.designs.caliptra.sha512

Chameleon
---------

.. automodule:: scgallery.designs.chameleon.chameleon

Dynamic Node
------------

.. automodule:: scgallery.designs.dynamic_node.dynamic_node

Ethmac
---------

.. automodule:: scgallery.designs.ethmac.ethmac

GCD
---------

Expand All @@ -10,3 +47,54 @@ Heartbeat
---------

.. automodule:: scgallery.designs.heartbeat.heartbeat

IBEX
---------

.. automodule:: scgallery.designs.ibex.ibex

JPEG
---------

.. automodule:: scgallery.designs.jpeg.jpeg

Microwatt
---------

.. automodule:: scgallery.designs.microwatt.microwatt

Mock ALU
---------

.. automodule:: scgallery.designs.mock_alu.mock_alu

openmsp430
----------

.. automodule:: scgallery.designs.openmsp430.openmsp430

riscv32i
---------

.. automodule:: scgallery.designs.riscv32i.riscv32i

swerv
---------

.. automodule:: scgallery.designs.swerv.swerv

tiny_rocket
-----------

.. automodule:: scgallery.designs.tiny_rocket.tiny_rocket

uart
---------

.. automodule:: scgallery.designs.uart.uart

ZeroSOC
---------

.. automodule:: scgallery.designs.zerosoc.run_flat
.. automodule:: scgallery.designs.zerosoc.run_hierarchy
2 changes: 1 addition & 1 deletion orfs/designs/tiny_rocket/rules.json
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@
"round": false,
"value": 0.95
},
"value": 0.0
"value": -0.14
},
{
"compare": "<=",
Expand Down
2 changes: 1 addition & 1 deletion scgallery/designs/tiny_rocket/rules.json
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@
"round": false,
"value": 0.95
},
"value": 0.0
"value": -0.14
},
{
"compare": "<=",
Expand Down

0 comments on commit ecfc8b5

Please sign in to comment.