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

The Oh My Zsh Read Me Section on Themes can be confusing RE: ps://github.com/ohmyzsh/ohmyzsh?tab=readme-ov-file#using-oh-my-zsh #12510

Open
OldSubSailor opened this issue Jun 16, 2024 · 0 comments
Labels
Feature New feature or request

Comments

@OldSubSailor
Copy link

OldSubSailor commented Jun 16, 2024

If the feature request is for a plugin or theme, specify it here.

Changing to the agnoster theme is insufficiently referenced

If the feature solves a problem you have, specify it here.

I am speaking from Mac experience. There is a note that speaks to installing fonts and that is all. Opening a new terminal window will result in a prompt that is almost impossible to read in the blue area, and indeed, your example of the agnoster theme shows this. If you go to the agnoster GitHub page: https://github.com/agnoster/agnoster-zsh-theme, you will see that the README opening section speaks to more, as does the Compatibility section.

Further if you read the agnoster.zsh-theme file you will find a detailed README section in it that specifies what the users need to do in order to make the them readable.

Describe the proposed feature.

I proprose two options:

  1. Replace the agnoster theme with a more user friendly prompt.
  2. Edit the section on Themes before the agnoster theme to provide further warning regarding what else is needed and a link to the agnoster GitHub page

Describe alternatives you've considered

Include this README intro before the agnoster theme. NOTICE that agnoster was designed for people who already have set up their terminals in a specific manner.

agnoster.zsh-theme

A ZSH theme optimized for people who use:

Solarized
Git
Unicode-compatible fonts and terminals (I use iTerm2 + Menlo)
For Mac users, I highly recommend iTerm 2 + Solarized Dark

https://github.com/Lokaltog/powerline-fonts

Additional context

Screenshot not set-up as per instructions
notsetupatall

Screenshot set-up as per instructions
asperinstructions

Related Issues

No response

@OldSubSailor OldSubSailor added the Feature New feature or request label Jun 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

1 participant