You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-17Lines changed: 11 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,27 +43,23 @@ These commands are available:
43
43
44
44
Only `OpenProject` is discussed in detail in this document because it is the main command.
45
45
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.
51
47
52
48
## Installation
53
49
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.
55
51
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`.
57
53
58
54
With version 0.23 Cider became a Tatin package. That simplifies the installation process: all you need to do is issue this command:
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`.
65
61
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.
67
63
68
64
Example:
69
65
@@ -93,7 +89,7 @@ Accepts an optional parameter that must be one of:
93
89
94
90
If no such parameter is specified, then the current directory is searched for a file `cider.config`.
95
91
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
97
93
* If no such file exists, then under Windows a dialog box is opened that allows the user to navigate to a Cider project
98
94
99
95
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
106
102
1. Creates the project space (namespace)
107
103
1. Sets the system variables `⎕IO` and `⎕ML` in the project space
108
104
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.
110
106
111
107
This may happen if the package install folders are not uploaded to, say, GitHub (`.gitignore`) and the project has just been downloaded.
112
108
1. Ask the user whether Cider should check all Tatin packages (if there are any) for later versions
@@ -148,9 +144,7 @@ Notes:
148
144
149
145
### `CloseProject`
150
146
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.
154
148
155
149
You may specify the `-all` flag to close all projects in `#` (*not*`⎕SE`!), but check the user command's detailed help (`-??`) for details.
156
150
@@ -163,7 +157,7 @@ Creates a file `cider.config` in that folder.
163
157
164
158
### `Config`
165
159
166
-
Allow the user to edit Cider's global config file.
160
+
Allows the user to edit Cider's global config file.
167
161
168
162
169
163
### `Help`
@@ -176,7 +170,7 @@ Prints the contents of a `.linkconfig` file to the session. Alternatively, the u
176
170
177
171
### `AddNuGetDependencies`
178
172
179
-
Use this to add NuGet dependencies
173
+
Use this to add NuGet dependencies.
180
174
181
175
### `AddTatinDependencies`
182
176
@@ -219,7 +213,7 @@ Returns a three-item-vector with "Name", "Version number" and "Version date".
219
213
220
214
### `UpdateCider`
221
215
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).
0 commit comments