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

Please add a license and a screen shot #1

Closed
unixorn opened this issue Aug 10, 2024 · 3 comments
Closed

Please add a license and a screen shot #1

unixorn opened this issue Aug 10, 2024 · 3 comments

Comments

@unixorn
Copy link

unixorn commented Aug 10, 2024

I'd like to add this to awesome-zsh-plugins, but I prefer to add themes with screen shots in the readme so that users can see what they look like without having to install them.

Also, please add a license file, some people won't use any code that doesn't have an open source license. If you don't have one in mind, https://choosealicense.com is a good resource to help you select an appropriate one.

Finally - consider moving the theme file to the root of the repository. This will make it easier for framework users to add your theme since most ZSH frameworks will automatically find .zsh-theme and .plugin.zsh files at the root of repositories - if it isn't there, the users have to special-case adding your theme.

This also makes it better to have one repository per theme - I get that you're collecting ones that work well on dark-themed machines, but I recommend having separate repos for each theme with links to each other in their readmes.

Thanks!

@hrmeetsingh
Copy link
Owner

Thanks @unixorn , have added a separate repo for this particular theme https://github.com/hrmeetsingh/sorin-modified-dark as you suggested(with a licence and screenshot). you can us the new one. Will keep this repo to maintain a collection of themes

Thanks for the suggestion

@unixorn
Copy link
Author

unixorn commented Aug 13, 2024

Thanks, added in unixorn/awesome-zsh-plugins#1895. Might be easiest to make your other repos submodules here so you don't have to update your themes in multiple places.

If the description of https://github.com/hrmeetsingh/sorin-modified-dark needs tweaking, either make an issue or PR it in unixorn/awesome-zsh-plugins directly.

@hrmeetsingh
Copy link
Owner

Thanks @unixorn , your repo is a goldmine and I'm glad that my contribution made it into it. I am tempted to try most of the themes here. Appreciate the effort you put in to maintain. Will definitely raise a PR if I have a new theme/plugin.

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

No branches or pull requests

2 participants