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 unnecessary prefixes from CLI docs #1254

Merged
merged 4 commits into from
Jun 29, 2024
Merged

Conversation

LostXOR
Copy link
Contributor

@LostXOR LostXOR commented Jun 27, 2024

The CLI docs have $ and ./ prefixes before each command. This is confusing, as the $ is not a part of the command at all and the ./ is Unix-specific.

This PR removes the prefixes from the commands, and adds a note at the beginning explaining that the ./ prefix should be added for MacOS/Linux users.

@Tyrrrz
Copy link
Owner

Tyrrrz commented Jun 27, 2024

./ is also required on Windows with PowerShell if I remember correctly. Can you check?

@LostXOR
Copy link
Contributor Author

LostXOR commented Jun 28, 2024

I'm not sure, but the docs specify to use Command Prompt, and ./ doesn't work with it.

After extracting the .zip, open Command Prompt, aka cmd (Terminal on macOS and Linux).

@CharithBhat
Copy link

CharithBhat commented Jun 28, 2024

Tried it on Windows Powershell. ./ is required.
But with Command Prompt. I have to remove the ./ for it to work.

@Tyrrrz
Copy link
Owner

Tyrrrz commented Jun 28, 2024

So it seems that all shells except Command Prompt require the ./, while Command Prompt doesn't work with ./. It's annoying. Maybe it's better to keep the ./ in docs and just add a note for Command Prompt users?

@LostXOR
Copy link
Contributor Author

LostXOR commented Jun 29, 2024

I guess that's probably best, I've updated the docs accordingly.

.docs/Using-the-CLI.md Outdated Show resolved Hide resolved
.docs/Using-the-CLI.md Outdated Show resolved Hide resolved
@Tyrrrz Tyrrrz merged commit 767ca1b into Tyrrrz:master Jun 29, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants