cacharle
commented
1 month ago That's fine, you can make a PR if you want
Sep 30, 2024 12:10:43 yavi337 @.***>:
I would like to propose a subtle enhancement to the installation instructions outlined in the README.md file for this project. The inclusion of the $ symbol preceding the commands may create a degree of confusion for some users, particularly those who are new to the command line experience, myself included.
Remove the $ symbol: This eliminates potential confusion for new command-line users. Add clear instructions: The text explicitly indicates what to type and when to use each command.
Current example:
$ pip3 install c-formatter-42 $ pip3 install --user c-formatter-42
Proposed example: pip3 install c-formatter-42 pip3 install --user c-formatter-42
— Reply to this email directly, view it on GitHub[https://github.com/dawnbeen/c_formatter_42/issues/79], or unsubscribe[https://github.com/notifications/unsubscribe-auth/AGBTCVMLTALFDHMB7XE4PBDZZEPSDAVCNFSM6AAAAABPC5XOHCVHI2DSMVQWIX3LMV43ASLTON2WKOZSGU2TMMJYGI2TOMA]. You are receiving this because you are subscribed to this thread. [Tracking image][https://github.com/notifications/beacon/AGBTCVK4EZY6Q43HNFTDIM3ZZEPSDA5CNFSM6AAAAABPC5XOHCWGG33NNVSW45C7OR4XAZNFJFZXG5LFVJRW63LNMVXHIX3JMTHJQXCAFI.gif]
I would like to propose a subtle enhancement to the installation instructions outlined in the README.md file for this project. The inclusion of the $ symbol preceding the commands may create a degree of confusion for some users, particularly those who are new to the command line experience, myself included.
Remove the $ symbol: This eliminates potential confusion for new command-line users. Add clear instructions: The text explicitly indicates what to type and when to use each command.
Current example:
$ pip3 install c-formatter-42 $ pip3 install --user c-formatter-42
Proposed example: pip3 install c-formatter-42 pip3 install --user c-formatter-42