privacy-scaling-explorations / zk-kit

A monorepo of reusable libraries for zero-knowledge technologies.
https://zkkit.pse.dev
MIT License
291 stars 79 forks source link

Typo fix Update README.md #349

Closed defitricks closed 1 week ago

defitricks commented 1 week ago

Description

The command provided for adding a path to ~/.zshrc uses the -n flag with echo:

echo -n 'export PATH=$HOME/bin:$PATH' >> ~/.zshrc

The -n flag suppresses the newline, which can cause the appended line to merge with the last line in ~/.zshrc. This may lead to configuration errors, especially if the file does not end with a newline.

Fix:

The corrected command removes the -n flag:

echo 'export PATH=$HOME/bin:$PATH' >> ~/.zshrc

This ensures proper appending of the line, preventing potential issues with shell configuration.

Importance:

This fix is crucial for ensuring that users setting up LaTeX on Mac systems follow accurate and reliable instructions. Incorrect configurations can lead to debugging challenges, particularly for users unfamiliar with shell scripting or environment setup.

Changes:

Testing:

Tested the corrected command on macOS with Zsh to verify that it appends the path configuration properly to ~/.zshrc without breaking existing configurations.

Please review and merge to improve the accuracy of the setup guide. 😊

Checklist

cedoor commented 1 week ago

cc @vplasencia

gitpoap-bot[bot] commented 1 week ago

Congrats, your important contribution to this open-source project has earned you a GitPOAP!

GitPOAP: 2024 ZK-KIT Contributor:

GitPOAP: 2024 ZK-KIT Contributor GitPOAP Badge

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.