search

zsh-users / zsh-syntax-highlighting

Fish shell like syntax highlighting for Zsh.
github.com/zsh-users/zsh-syntax-highlighting
BSD 3-Clause "New" or "Revised" License
19.55k stars 1.32k forks source link

Update INSTALL.md #884

Closed WilliamStar007 closed 1 year ago

WilliamStar007 commented 2 years ago

Made the document more structured and easier to read.

WilliamStar007 commented 2 years ago

I kept all the links in the original installation guide and followed the general structure of zsh-autosuggestions Install.md. This PR would make the installation guides more uniform across different zsh plugins/packages.

phy1729 commented 2 years ago

zsh-syntax-highlighting is neutral towards operating systems and plugin managers (aside from preferring manual installation over a plugin manager), so both lists must remain in alphabetical order. A table of contents was suggested in #820 and was decided against.

Looking at INSTALL.md there are some changes that need to be made: Mac OS X has rebranded to macOS, the link texts in stretch and in Xenial are out of date (and preferably would be replaced with some text that doesn't periodically need updating). No strong preference on a list or table for the packages.

WilliamStar007 commented 2 years ago

I wanted to update the Install.md because I worked with both zsh-autosuggestions and zsh-syntax-highlighting, and I think their installation guide is more organized and easier to follow. Thus, I thought updating this project's install.md would be a good idea. That's all, and I am very open to ideas.

For the in stretch and in Xenial links, I included them out of respect for the original installation guide since I am new to this project. I have no idea if there are better links to replace them, and thus I think keeping them, for now, is probably a good idea. As for alphabetical order and changing Max OS X to macOS, I totally agree. I will update this PR. Thanks for the advice!

WilliamStar007 commented 2 years ago

Changed "Mac OS" to "macOS"; All packages are now in alphabetical order; Manual Installation is at the top of the guide since it is preferred; Oh My ZSH is still a separate section because I think it is very popular. (just my personal opinion)

phy1729 commented 2 years ago

Special casing Oh My Zsh is giving it special treatment which isn't ok since z-sy-h should remain neutral. Aside from the changes mentioned in my previous comment, I think the page should remain basically as is.

WilliamStar007 commented 2 years ago

ok... I removed the special case for Oh My Zsh. I think that my proposed organization and structure are better than the current one (that's why I made a pull request). However, it is indeed a difference in opinion with no objective measurements. So, I guess it is up to the maintainers.

I really like this project and am currently using it. I wish this project all the best.