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

Typo fix Update README.md #349

Merged
merged 1 commit into from
Nov 20, 2024

Conversation

defitricks
Copy link
Contributor

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:

  • Updated the relevant command in the documentation to remove the -n flag from echo.

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

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • I have run yarn style without getting any errors
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Fix incorrect echo command in LaTeX setup instructions for Mac
@cedoor
Copy link
Member

cedoor commented Nov 20, 2024

cc @vplasencia

@cedoor cedoor merged commit 2dc9a19 into privacy-scaling-explorations:main Nov 20, 2024
3 checks passed
Copy link

gitpoap-bot bot commented Nov 20, 2024

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.

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

Successfully merging this pull request may close these issues.

3 participants