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

Incongruence in documentation #36

Open
GiuseppeChillemi opened this issue Jun 26, 2019 · 1 comment
Open

Incongruence in documentation #36

GiuseppeChillemi opened this issue Jun 26, 2019 · 1 comment
Assignees

Comments

@GiuseppeChillemi
Copy link

In the main readme on GITHUB you read:

Install Red (Note: For Windows user, need to run red.exe --cli)

On Windows 10 "--cli" is automatically added and if you add another one this led to an incorrect command line

@qtxie
Copy link
Collaborator

qtxie commented Jun 27, 2019

Install Red (Note: For Windows user, need to run red.exe --cli)

This is a step in Quick Start. It is for the user who haven't set "red.redPath". So you have to run red.exe --cli in the CMD once, otherwise the plugin don't know where to find the Red interpreter. The red.redPath is only for the user who want to compile Red source code directly using the plugin.

Maybe change it to this is more clear:

* Install Red Interpreter
  Run red.exe once in the terminal. 
  (Note: For Windows user, need to add the `--cli` option, red.exe --cli)

We're willing to make the document more clear, any suggestions are welcome. :-)

@qtxie qtxie self-assigned this Jun 27, 2019
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