search

The-OpenROAD-Project / OpenLane-MPW-CI

BSD 3-Clause "New" or "Revised" License
15 stars 5 forks source link

The "designs" directory should have an index file #32

Closed mithro closed 2 years ago

mithro commented 2 years ago

The designs directory has quite a large number of designs but no information at all about them. It would be good to have a README.md file which described some information about each design.

Relevant information would be;

mithro commented 2 years ago

Maybe status / build badges would be good too...

vijayank88 commented 2 years ago

The designs directory has quite a large number of designs but no information at all about them. It would be good to have a README.md file which described some information about each design.

Relevant information would be;

* Name.

* Short description.

* Who made it.

* Type of design.

* Where / when it was taped out.

* Link to the current status on CI.

* Link to a dashboard which shows the metrics about the design over time.

We are maintains a spreadsheet internally, which contain all above details.

I will make it as markdown format.

vijayank88 commented 2 years ago

@vvbandeira As we are maintaining spreadsheet here: https://docs.google.com/spreadsheets/d/1WEw40LbszfU73tOpUKDtW8G1I-jhOVI5yRYKzGZa8EI/edit#gid=0 Is possible to create a link to such spreadsheet, so whenever we update, its automatically get update here as well?

vvbandeira commented 2 years ago

@vijayank88 we could add a URL to the spreadsheet, but I believe that having a README.md index as Tim suggested is a better practice. This way the list is contained in the repo itself.

vijayank88 commented 2 years ago

@mithro Please check this fork https://github.com/vijayank88/OpenLane-MPW-CI/blob/mpw_readme/MPW-2_README.md Created for MPW-2 shuttle design list and its URL. Please review and let me know to update or discard any columns from the markdown file. @vvbandeira FYI

mithro commented 2 years ago

It looks like it is heading in the right direction, but the README should be for the whole directory not a specific MPW? I shouldn't need to understand the efabless MPW runs to understand the contents of this directory.

vijayank88 commented 1 year ago

Yes... Got your point... I will update and share again for review.

On Wed, May 4, 2022, 7:19 PM mithro @.***> wrote:

It looks like it is heading in the right direction, but the README should be for the whole directory not a specific MPW? I shouldn't need to understand the efabless MPW runs to understand the contents of this directory.

— Reply to this email directly, view it on GitHub https://github.com/The-OpenROAD-Project/OpenLane-MPW-CI/issues/32#issuecomment-1117338128, or unsubscribe https://github.com/notifications/unsubscribe-auth/AUOQKCLPFLF24KFO4MPC6S3VIJ6AJANCNFSM5UP3JA7A . You are receiving this because you were mentioned.Message ID: @.***>