chipsalliance / tac

CHIPS Alliance Technical Advisory Council
https://www.chipsalliance.org/
Apache License 2.0
5 stars 22 forks source link

Create caliptra.md #109

Closed mcockrell-google closed 1 year ago

mgielda commented 1 year ago

Hi @andreslagarcavilla @mcockrell-google note that we are adopting a new format for this data. @cjyabraham and me will help reformat so that Caliptra can land on the website in the "projects" section.

cjyabraham commented 1 year ago

The new yml format can be seen here: f4pga.yml And project logo can be placed in tsc/projects/logos/

andreslagarcavilla commented 1 year ago

we have pngs, let me dig svg

mgielda commented 1 year ago

Can you put the below in a caliptra.yml (not md) file for now? Of course you can change any of this. For repos, we don't support descriptions for now (I think) but it's a fixable problem.

name: Caliptra
# Project status - sandbox, graduated or archived
status: sandbox
# Links to project repos - may be one or list of several in YAML list format
repositories:
  - https://github.com/chipsalliance/caliptra
  - https://github.com/chipsalliance/caliptra-rtl
  - https://github.com/chipsalliance/caliptra-sw
  - https://github.com/chipsalliance/caliptra-ureg
  - https://github.com/chipsalliance/caliptra-dpe
# A one-sentence summary of the project
brief_summary: The Caliptra project focuses on development of HW and SW IP for The Caliptra Root of Trust
# The project's open source license, normally Apache 2.0 unless special exception is granted
license: Apache-2.0
# Link to issue tracker
issue_tracker_link: https://github.com/chipsalliance/Caliptra/issues
# Link to website
website_link: https://github.com/chipsalliance/Caliptra/blob/main/README.md
# Links to social media, if present, can be a list, or N/A if none
social_media_links: N/A
# Brief summary of how widely the project is used e.g. list of companies
project_usage_and_scale: Google, AMD, Microsoft, NVIDIA and other project particupants. 
# Project's motivation to join CHIPS
why_join_chips: CHIPS Alliance is a common forum for Caliptra development enabling enable cross-company collaboration, adoption of CHIPS open source RTL tools and collaborative methodologies and outreach to a broader community of interested parties
# The primary contact person for the project, will become TSC representative once admitted
primary_contact:
  # Contact's full name
  name: Matt Cockrell
  # Contact's work email
  email: mcockrell@google.com
  # Contact's GH handle, without the @
  github_handle: mcockrell-google
  # Contact's role in the project
  project_role: IC
### Data above this line is needed for Sandbox application, additional data below is needed for Graduated application
# Link to logo in .svg format, if present
svg_logo_link: logos/caliptra.svg

We can fill in the remaining data as needed later, when we graduate the project.

mgielda commented 1 year ago

Ah, and please add a logo to projects/logos/ in the same PR. I saw the logo is already there in the Caliptra repo.