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

Interactive Command LIne Documentation #49

Open
19smuh23 opened this issue Mar 28, 2024 · 1 comment
Open

Interactive Command LIne Documentation #49

19smuh23 opened this issue Mar 28, 2024 · 1 comment

Comments

@19smuh23
Copy link

In the Readme file, the interactive command line syntax is given as: crelay [-s ] -i | [] [ON|OFF]. For someone well versed in Linux, the syntax may be obvious from the above. But I am not, so it took me a long time to figure out that you have to repeat the crelay command after the pipe. What worked for me was: crelay -i [-s ] | crelay [] [ON|OFF]. I also put "-i" before the serial number. Perhaps you could give some example commands in the documentation to make it clear to newbies.

@ondrej1024
Copy link
Owner

I agree, the syntax might not be obvious to someone approaching the command line for the first time. I will add some examples in the doc.

Here just a short explanation of the syntax elements:
<x> this is a placeholder for a required parameter (you need to provide a value for x)
[x] this is an optional parameter (you can provide a value for x if needed)
x|y this is an alternative (you need to provide a value either for x or for y)

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