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

What about a standard badge for package README files ? #108

Closed
j-fu opened this issue Nov 27, 2024 · 4 comments · Fixed by #112
Closed

What about a standard badge for package README files ? #108

j-fu opened this issue Nov 27, 2024 · 4 comments · Fixed by #112

Comments

@j-fu
Copy link

j-fu commented Nov 27, 2024

May be this ?

Runic Formatted
@fredrikekre
Copy link
Owner

I was a bit skeptical of this when reading the issue title but it is kinda funny that you can use unicode in the label.

It seems that it is convention to use code style for this (see e.g. https://github.com/psf/black?tab=readme-ov-file#show-your-style and https://github.com/prettier/prettier?tab=readme-ov-file#badge) so perhaps this:

Runic Formatted

Some other more cryptic but nice looking alternatives:
Runic Formatted
Runic Formatted

@j-fu
Copy link
Author

j-fu commented Nov 28, 2024

Yeah didn't know this either, thought to create some image, just got the idea to try.

I think the "code style" version would be the way to go. And of course it is yours to decide, including the colors...

fredrikekre added a commit that referenced this issue Nov 28, 2024
@fredrikekre
README updates
af067a0 
This patch make some changes to the README:
 - Use name instead of URL for installation instructions
 - Create a new section on adopting Runic for a code base
 - Add a suggested README badge (closes #108).
@fredrikekre fredrikekre mentioned this issue Nov 28, 2024
Merged
fredrikekre added a commit that referenced this issue Nov 28, 2024
@fredrikekre
README updates
a6ecd2b 
This patch make some changes to the README:
 - Use name instead of URL for installation instructions
 - Create a new section on adopting Runic for a code base
 - Add a suggested README badge (closes #108).
fredrikekre added a commit that referenced this issue Nov 28, 2024
@fredrikekre
README updates (#112)
72a43c5 
This patch make some changes to the README:
 - Use name instead of URL for installation instructions
 - Create a new section on adopting Runic for a code base
 - Add a suggested README badge (closes #108).
@fredrikekre
Copy link
Owner

https://github.com/fredrikekre/Runic.jl?tab=readme-ov-file#badge

@fredrikekre
Copy link
Owner

Thanks for the idea and suggestion, I think it looks cool :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

README updates fredrikekre/Runic.jl
2 participants
@j-fu @fredrikekre