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.

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

Update README.md #20

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Update README.md #20

wants to merge 4 commits into from

Conversation

shenxianpeng
Copy link
Contributor

update the readme page to include other repositories that we provided.

@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Mar 6, 2024
@shenxianpeng shenxianpeng marked this pull request as ready for review March 6, 2024 06:30
@shenxianpeng shenxianpeng requested a review from 2bndy5 March 6, 2024 06:34
@2bndy5
Copy link
Contributor

2bndy5 commented Mar 6, 2024

You know, we could generate our own pinned repos using the profile's README.

@2bndy5
Copy link
Contributor

2bndy5 commented Mar 6, 2024

[![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=cpp-linter&repo=clang-tools-pip)](https://github.com/cpp-linter/clang-tools-pip)

renders as

Readme Card

We can even customize it further by adding arguments to the endpoint

  • using &show_owner=true argument:
    Readme Card
  • using &theme=transparent (+ &show_owner=true):
    Readme Card
    This might allow for different github user preferences about chosen theme. I guess we could also use Github new media feature as well.

@2bndy5
Copy link
Contributor

2bndy5 commented Mar 6, 2024

I see another customization that would allow different user-selected themes without using a beta GH media feature:

Github context tags

[![repo card(dark)](https://github-readme-stats.vercel.app/api/pin/?username=cpp-linter&repo=clang-tools-pip&show_owner=true&theme=vue-dark#gh-dark-mode-only)](https://github.com/cpp-linter/clang-tools-pip#gh-dark-mode-only)
[![repo card(light)](https://github-readme-stats.vercel.app/api/pin/?username=cpp-linter&repo=clang-tools-pip&show_owner=true&theme=catppuccin_latte#gh-light-mode-only)](https://github.com/cpp-linter/clang-tools-pip#gh-light-mode-only)

repo card(dark)
repo card(light)

@shenxianpeng
Copy link
Contributor Author

You know, we could generate our own pinned repos using the profile's README.

we just used all the pinned repos. I went back to the README and it is pretty good, unless it's much better than it is now, it's better not to change it. thanks for sharing the links.

@shenxianpeng shenxianpeng reopened this Mar 6, 2024
@shenxianpeng shenxianpeng marked this pull request as draft March 6, 2024 14:54
Copy link
Contributor

@2bndy5 2bndy5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was only trying to avoid re-typing each linked repo's description by using generated cards. But maybe that idea is too visually noisy when we are still pinning repos without the README.

@shenxianpeng
Copy link
Contributor Author

so I'd update the description manually or an action/script to update automatically if any change.

@github-actions github-actions bot added the Stale label Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants