Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

projects: Change format for README.md #1419

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

projects: Change format for README.md #1419

wants to merge 1 commit into from
+420 −178

Conversation

IuliaCMoldovan
Copy link
Contributor

PR Description

This PR will be a draft PR until we decide on a format for our README.md files present in each project folder. Open to discussions.
I started on the pulsar_adc one, as it seems more complex.

PR Type

  • Bug fix (change that fixes an issue)
  • New feature (change that adds new functionality)
  • Breaking change (has dependencies in other repos or will cause CI to fail)

PR Checklist

  • I have followed the code style guidelines
  • I have performed a self-review of changes
  • I have compiled all hdl projects and libraries affected by this PR
  • I have tested in hardware affected projects, at least on relevant boards
  • I have commented my code, at least hard-to-understand parts
  • I have signed off all commits from this PR
  • I have updated the documentation (wiki pages, ReadMe files, Copyright etc)
  • I have not introduced new Warnings/Critical Warnings on compilation
  • I have added new hdl testbenches or updated existing ones

@IuliaCMoldovan IuliaCMoldovan force-pushed the new_readme branch 3 times, most recently from 738cec2 to f474187 Compare August 21, 2024 13:13
@IuliaCMoldovan
update readmes
2664b62 
 * projects/pulsar_adc
 * projects/ad_gmsl2eth_sl
 * projects/ad_quadmxfe1_ebz
 * projects/ad411x_ad717x
 * Added template for readme: projects/common/README.md
 * projects/ad3552r_evb/Readme.md
 * projects/ad469x_fmc/Readme.md
 * projects/ad485x_fmcz/Readme.md
 * projects/ad719x_asdz/README.md
 * projects/ad738x_fmc/Readme.md
 * projects/ad777x_ardz/Readme.md

Signed-off-by: Iulia Moldovan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@FilipG24 FilipG24 Awaiting requested review from FilipG24 FilipG24 will be requested when the pull request is marked ready for review FilipG24 is a code owner

@LBFFilho LBFFilho Awaiting requested review from LBFFilho LBFFilho will be requested when the pull request is marked ready for review LBFFilho is a code owner

@PopPaul2021 PopPaul2021 Awaiting requested review from PopPaul2021 PopPaul2021 will be requested when the pull request is marked ready for review PopPaul2021 is a code owner

@acostina acostina Awaiting requested review from acostina acostina will be requested when the pull request is marked ready for review acostina is a code owner

@PIoandan PIoandan Awaiting requested review from PIoandan PIoandan will be requested when the pull request is marked ready for review PIoandan is a code owner

@sarpadi sarpadi Awaiting requested review from sarpadi sarpadi will be requested when the pull request is marked ready for review sarpadi is a code owner

@StancaPop StancaPop Awaiting requested review from StancaPop StancaPop will be requested when the pull request is marked ready for review StancaPop is a code owner

@AndreiGrozav AndreiGrozav Awaiting requested review from AndreiGrozav AndreiGrozav will be requested when the pull request is marked ready for review AndreiGrozav is a code owner

@gastmaier gastmaier Awaiting requested review from gastmaier gastmaier will be requested when the pull request is marked ready for review gastmaier is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
doc
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@IuliaCMoldovan