VScode-extension icon indicating copy to clipboard operation
VScode-extension copied to clipboard

Incongruence in documentation

Open GiuseppeChillemi opened this issue 5 years ago • 1 comments

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

GiuseppeChillemi avatar Jun 26 '19 21:06 GiuseppeChillemi

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 avatar Jun 27 '19 04:06 qtxie