Clarifying instructions

Clarifying users need to clone the repo first (duh), and unless the CWD is in their PATH they will need to run `./` first.
This commit is contained in:
Max Coplan 2019-11-18 19:52:19 -05:00 committed by GitHub
parent 6dab4f7576
commit bbbeecd253
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -19,9 +19,12 @@ There are **two** ways to make the Wolfram Language available in Jupyter:
## Method 1: Using `wolframscript`
Run the following command to make the Wolfram Language engine available to Jupyter:
Clone the repository
git clone https://github.com/WolframResearch/WolframLanguageForJupyter.git
Run the following command in your shell to make the Wolfram Language engine available to Jupyter:
configure-jupyter.wls add
./configure-jupyter.wls add
**Notes:**
@ -31,7 +34,7 @@ Run the following command to make the Wolfram Language engine available to Jupyt
For more configuration options run:
configure-jupyter.wls help
./configure-jupyter.wls help
## Method 2: Using Wolfram Language
@ -39,7 +42,7 @@ You can download the latest version of the paclet here:
https://github.com/WolframResearch/WolframLanguageForJupyter/releases
To install the paclet, run the following command (replacing x, y, and z with the correct values):
To install the paclet, run the following command with Wolfram Language (replacing x, y, and z with the correct values):
PacletInstall["WolframLanguageForJupyter-x.y.z.paclet"]
@ -69,7 +72,7 @@ The following command should now list the Wolfram Engine:
The output should include a line like this:
wolframlanguage-11.3.0 C:\ProgramData\jupyter\kernels\wolframlanguage-11.3.0
wolframlanguage12 C:\ProgramData\jupyter\kernels\wolframlanguage12
To test your installation, run the following command:
@ -95,7 +98,7 @@ Any messages that occur during evaluation are displayed:
To build the WolframLanguageForJupyter paclet file yourself, run:
configure-jupyter.wls build
./configure-jupyter.wls build
This creates the `WolframLanguageForJupyter-x.y.z.paclet` file (use the `PacletInfo.m` to increment the version).
@ -105,7 +108,7 @@ This creates the `WolframLanguageForJupyter-x.y.z.paclet` file (use the `PacletI
Run the following command to remove the Wolfram Language engine from Jupyter:
configure-jupyter.wls remove
./configure-jupyter.wls remove
## Method 2: Using Wolfram Language