Skip to content

Commit c831d66

Browse files
committed
Improve readme file configuration instructions
1 parent 9fbc88c commit c831d66

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -187,12 +187,12 @@ No defaults (VSCode doesn't support using environment variables to define settin
187187
"logtalk.executable.path": "/usr/local/bin/logtalk"
188188
"logtalk.executable.arguments": [ ]
189189

190-
Logtalk executable or integration script plus its arguments. The `logtalk` executable can be created by running the `logtalk_backend_select` script. In alternative, use the integration script you want to use. Absolute paths **must** be used. For example, assuming a POSIX system (e.g. macOS, Linux, or BSD):
190+
Logtalk executable or integration script plus its arguments. On POSIX systems (e.g. macOS, Linux, or BSD), the `logtalk` executable can be created by running the `logtalk_backend_select` script. In alternative, use the integration script you want to use. Absolute paths **must** be used. For example, assuming a POSIX system and using SWI-Prolog as the backend:
191191

192192
"logtalk.executable.path": "/usr/local/bin/swilgt"
193193
"logtalk.executable.arguments": [ "-q" ]
194194

195-
On Windows systems, use the absolute path to the Prolog backend executable **and** then set the arguments to load Logtalk (look into the properties of the Logtalk integration shortcuts that are available from the Start Menu after installing Logtalk). For example (assuming the default Logtalk installation):
195+
On Windows systems, use the absolute path to the Prolog backend executable **and** then set the arguments to load Logtalk (look into the properties of the Logtalk integration shortcuts that are available from the Start Menu after installing Logtalk). For example (assuming the default Logtalk installation) and using SWI-Prolog as the backend:
196196

197197
"logtalk.executable.path": "C:/Program Files/swipl/bin/swipl.exe"
198198
"logtalk.executable.arguments": [
@@ -205,12 +205,12 @@ On Windows systems, use the absolute path to the Prolog backend executable **and
205205
"logtalk.tester.script": "/usr/local/bin/logtalk_tester"
206206
"logtalk.tester.arguments": [ ]
207207

208-
Automation script for running tests and its arguments. The arguments **must** included at least the Prolog backend. For example, assuming a POSIX system (e.g. macOS, Linux, or BSD):
208+
Automation script for running tests and its arguments. The arguments **must** included at least the Prolog backend. For example, assuming a POSIX system (e.g. macOS, Linux, or BSD) and using SWI-Prolog as the backend:
209209

210210
"logtalk.tester.script": "/usr/local/bin/logtalk_tester"
211211
"logtalk.tester.arguments": [ "-p", "swi" ]
212212

213-
On Windows systems, these settings must be set differently. For example (assuming the default Logtalk installation):
213+
On Windows systems, these settings must be set differently. For example (assuming the default Logtalk installation) and using SWI-Prolog as the backend:
214214

215215
"logtalk.tester.script": "C:/Program Files/PowerShell/7/pwsh.exe"
216216
"logtalk.tester.arguments": [
@@ -222,12 +222,12 @@ Automation script for running tests and its arguments. The arguments **must** in
222222
"logtalk.doclet.script": "/usr/local/bin/logtalk_doclet"
223223
"logtalk.doclet.arguments": [ ]
224224

225-
Automation script for running doclets and its arguments. The arguments **must** included at least the Prolog backend. For example, assuming a POSIX system (e.g. macOS, Linux, or BSD):
225+
Automation script for running doclets and its arguments. The arguments **must** included at least the Prolog backend. For example, assuming a POSIX system (e.g. macOS, Linux, or BSD) and using SWI-Prolog as the backend:
226226

227227
"logtalk.doclet.script": "/usr/local/bin/logtalk_doclet"
228228
"logtalk.doclet.arguments": [ "-p", "swi" ]
229229

230-
On Windows systems, these settings must be set differently. For example (assuming the default Logtalk installation):
230+
On Windows systems, these settings must be set differently. For example (assuming the default Logtalk installation) and using SWI-Prolog as the backend:
231231

232232
"logtalk.doclet.script": "C:/Program Files/PowerShell/7/pwsh.exe"
233233
"logtalk.doclet.arguments": [
@@ -269,7 +269,7 @@ Diagrams script for converting the `.dot` files generated by the Logtalk `diagra
269269

270270
"logtalk.scripts.timeout": 480000
271271

272-
The number of milliseconds to wait before running the scripts that convert `.xml` documentation files and `.dot` diagram files to final formats when running the `lgtdoc` and `diagrams` tools. This timeout is also used to wait for a file compilation to finish before adding any compiler errors or warnings to the "Problems" pane. You may need to set a value larger than the default value if you're compiling big applications.
272+
The number of milliseconds to wait before running the scripts that convert `.xml` documentation files and `.dot` diagram files to final formats when running the `lgtdoc` and `diagrams` tools. This timeout is also used to wait for a file compilation to finish before adding any compiler errors or warnings to the "Problems" pane and for waiting to answers from the Logtalk reflection API when using code navigation features. You may need to set a value larger than the default value if you're compiling big applications.
273273

274274
## Known Issues
275275

0 commit comments

Comments
 (0)