StreamDiffusion icon indicating copy to clipboard operation
StreamDiffusion copied to clipboard

chore(readme): Enclose URL in Quotes

Open Jannchie opened this issue 2 years ago • 1 comments

Thanks for this amazing work!


$ pip install git+https://github.com/cumulo-autumn/StreamDiffusion.git@main#egg=streamdiffusion[tensorrt]

zsh: no matches found: git+https://github.com/cumulo-autumn/StreamDiffusion.git@main#egg=streamdiffusion[tensorrt]

I am trying to install this package from a Git repository using pip with zsh. The error message zsh: no matches found typically occurs in the Z shell (zsh) when it tries to interpret special characters. In the command, the square brackets ([]) are likely causing the issue, as zsh treats them as a pattern-matching character.

To fix this, we can either escape the square brackets or enclose the entire URL in quotes. This change does not affect bash users and is compatible with zsh users.

Related stackoverflow link: https://stackoverflow.com/a/30539963/8625892

Jannchie avatar Dec 24 '23 00:12 Jannchie

Thank you for pointing out that problem and suggesting enclosing the entire URL in quotes which accommodates both environments.

However, since quotes are not commonly used in regular pip installations, I am a bit concerned that it might actually confuse people who don't usually use zsh. I am thinking about what to do with the README. Perhaps, it would be a good idea to add a separate note suggesting to try using quotes if the installation doesn't go smoothly. This is quite a subjective matter, so it's a bit difficult to decide. I'll think about it a bit more before making a decision. Anyway, thank you very much for your feedback and the suggestion for improvement!

cumulo-autumn avatar Dec 29 '23 08:12 cumulo-autumn