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

docs: make consistent, cleanup #123

Closed
wants to merge 3 commits into from
Closed

docs: make consistent, cleanup #123

wants to merge 3 commits into from

Conversation

uncenter
Copy link
Member

@uncenter uncenter commented Feb 6, 2024

Cleans up the READMEs to be clearer and consistent across tools.

whiskers/README.md Outdated Show resolved Hide resolved
@sgoudham
Copy link
Contributor

sgoudham commented Feb 6, 2024

I'm refactoring the whiskers README in #111 so I'd appreciate if you could revert those changes for that here.

@uncenter
Copy link
Member Author

uncenter commented Feb 6, 2024

I'm refactoring the whiskers README in #111 so I'd appreciate if you could revert those changes for that here.

I like the usage of the table for installation instructions. Maybe I apply what you've done for Whiskers for each of the READMEs here and then there wouldn't be a conflict after merging?

@sgoudham
Copy link
Contributor

sgoudham commented Feb 6, 2024

I think the table format only applies to catwalk and puccinier aside from whiskers, I don't mind if you update it for those but I'm planning on merging #111 probably right after this one (its marinated long enough lol) so reverting the entire file would be best for me 👍

@nekowinston
Copy link
Contributor

regarding the badges, we could still improve them by changing the issue button to https://github.com/catppuccin/toolbox/issues/new?labels=whiskers etc.
Note that puccinier doesn't have a label since it's effectively EOL

@uncenter
Copy link
Member Author

uncenter commented Feb 6, 2024

I think the table format only applies to catwalk and puccinier aside from whiskers

Aren't those... the only two other tools with READMEs? Anyway, do you prefer the table to what I have it as now? I don't mind either way.

@uncenter
Copy link
Member Author

uncenter commented Feb 6, 2024

regarding the badges, we could still improve them by changing the issue button to catppuccin/toolbox/issues/new?labels=whiskers etc. Note that puccinier doesn't have a label since it's effectively EOL

Will do... I'll just leave Puccinier as is I guess.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants