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

Remove $ from BUILD_INSTRUCTIONS.md command sequences #331

Open
ApprenticeofEnder opened this issue Feb 2, 2024 · 1 comment
Open

Remove $ from BUILD_INSTRUCTIONS.md command sequences #331

ApprenticeofEnder opened this issue Feb 2, 2024 · 1 comment

Comments

@ApprenticeofEnder
Copy link
Contributor

ApprenticeofEnder commented Feb 2, 2024

A lot of the command sequences BUILD_INSTRUCTIONS.md have dollar signs ($) as prefixes for each command, which cause errors in the terminal. For someone copy-pasting the commands, which is especially likely for sequences involving more than 2 commands, this makes it so that they have to trim the leading dollar signs.

Think removing them would be a good idea? Or if you want to keep them in, we could explore alternative embedded solutions.

@alexanderkjall
Copy link
Collaborator

The user friendliness of being able to copy paste out-weights the user friendliness of communicating that these are commands for the terminal.

I think you are correct in that they should be deleted.

I also think that I need to go over them and verify that they are still correct.

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

No branches or pull requests

2 participants