search

cortex / ripasso

A simple password manager written in Rust
GNU General Public License v3.0
707 stars 61 forks source link

Remove $ from BUILD_INSTRUCTIONS.md command sequences #331

Open ApprenticeofEnder opened 7 months ago

ApprenticeofEnder commented 7 months ago

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 commented 7 months ago

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.