Skip to content

Commit 11483df

Browse files
committed
Merge branch 'main' of https://github.com/aplteam/Cider
2 parents 789e820 + b3f8d68 commit 11483df

File tree

1 file changed

+11
-17
lines changed

1 file changed

+11
-17
lines changed

README.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -43,27 +43,23 @@ These commands are available:
4343

4444
Only `OpenProject` is discussed in detail in this document because it is the main command.
4545

46-
For all other commands only basic information is provided. A comprehensive User Guide is available as an HTML document, see [Cider-User-Guide.html](https://html-preview.github.io/?url=https://github.com/aplteam/Cider/blob/main/html/Cider-User-Guide.html).
47-
48-
The user command help is also pretty exhaustive.
49-
50-
Regarding the API, the document [Cider-API-Reference.html](https://html-preview.github.io/?url=https://github.com/aplteam/Cider/blob/main/html/Cider-API-Reference.html) is available.
46+
For all other commands, only basic information is provided. A comprehensive [User Guide](https://aplteam.github.io/Cider/) is available. The user command help is also pretty exhaustive.
5147

5248
## Installation
5349

54-
In version 19.0 Cider is part of a standard installation of Dyalog, although it needs activation before it is available. Therefore you only have to worry about installing it with versions 18.0 and 18.2. Cider does not run on earlier versions of Dyalog.
50+
In version 19.0 Cider is part of a standard installation of Dyalog, although it needs activation before it is available. Therefore you only have to worry about installing it with version 18.2; Cider does not run on earlier versions of Dyalog.
5551

56-
Cider can be activated with `]Activate Cider` (after first activating Tatin in a similar way because Tatin is required by Cider) or by activating Cider and Tatin in one step with `]Activate all`.
52+
Cider can be activated with `]Activate Cider` (after first activating Tatin in a similar way because Cider requires Tatin) or by activating Cider and Tatin in one step with `]Activate all`.
5753

5854
With version 0.23 Cider became a Tatin package. That simplifies the installation process: all you need to do is issue this command:
5955

6056
```
6157
]Tatin.InstallPackages [tatin]Cider <targetFolder>
6258
```
6359

64-
If it is installed into a folder that is scanned for user command scripts by Dyalog, then when a new instance of Dyalog is started,`]Cider` will be available. For an instance that was already running when Cider was installed, execute `]UReset`.
60+
If it is installed into a folder that is scanned for user command scripts by Dyalog, then when a new instance of Dyalog is started,`]Cider` will be available. For an instance already running when Cider was installed, execute `]UReset`.
6561

66-
If it is installed into a folder that is not scanned for user command scripts, you need to add that folder to the `cmddir` parameter of SALT.
62+
If it is installed into a folder not scanned for user command scripts, you must add that folder to the `cmddir` parameter of SALT.
6763

6864
Example:
6965

@@ -93,7 +89,7 @@ Accepts an optional parameter that must be one of:
9389

9490
If no such parameter is specified, then the current directory is searched for a file `cider.config`.
9591

96-
* If such a file exists the user is asked whether she really wants to open that project
92+
* If such a file exists, the user is asked whether she wants to open that project
9793
* If no such file exists, then under Windows a dialog box is opened that allows the user to navigate to a Cider project
9894

9995
On non-Windows platforms an error is thrown.
@@ -106,7 +102,7 @@ Once a folder is established that holds a Cider config file, the user command pe
106102
1. Creates the project space (namespace)
107103
1. Sets the system variables `⎕IO` and `⎕ML` in the project space
108104
1. Brings all code and variables into the project space
109-
1. Checks whether any Tatin install folders do not actually have any packages installed but have a non-empty dependency file.
105+
1. Checks whether any Tatin install folders do not have any packages installed but have a non-empty dependency file.
110106

111107
This may happen if the package install folders are not uploaded to, say, GitHub (`.gitignore`) and the project has just been downloaded.
112108
1. Ask the user whether Cider should check all Tatin packages (if there are any) for later versions
@@ -148,9 +144,7 @@ Notes:
148144

149145
### `CloseProject`
150146

151-
Takes one or more folders or a aliases and breaks the Link between the namespace and its folder for all of them.
152-
153-
Separate projects with space or commas.
147+
Takes one or more folders or aliases and breaks the Link between the namespace and its folder for all of them. Separate projects with space or commas.
154148

155149
You may specify the `-all` flag to close all projects in `#` (*not* `⎕SE`!), but check the user command's detailed help (`-??`) for details.
156150

@@ -163,7 +157,7 @@ Creates a file `cider.config` in that folder.
163157

164158
### `Config`
165159

166-
Allow the user to edit Cider's global config file.
160+
Allows the user to edit Cider's global config file.
167161

168162

169163
### `Help`
@@ -176,7 +170,7 @@ Prints the contents of a `.linkconfig` file to the session. Alternatively, the u
176170

177171
### `AddNuGetDependencies`
178172

179-
Use this to add NuGet dependencies
173+
Use this to add NuGet dependencies.
180174

181175
### `AddTatinDependencies`
182176

@@ -219,7 +213,7 @@ Returns a three-item-vector with "Name", "Version number" and "Version date".
219213

220214
### `UpdateCider`
221215

222-
Update Cider in case a later version is available as a package on [https://tatin.dev](https://tatin.dev).
216+
Updates Cider if a later version is available as a package on [https://tatin.dev](https://tatin.dev).
223217

224218

225219

0 commit comments

Comments
 (0)