linny-r 1.1.5 → 1.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +30 -35
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -44,23 +44,17 @@ so in all commands you should replace this with the actual directory path.
44
44
  On a Windows machine you may choose something like `C:\Users\xyz\Documents\Linny-R`,
45
45
  and on a macOS machine probably `/Users/xyz/Linny-R`.
46
46
 
47
- To install Linny-R in this directory, type at the command line prompt:
47
+ To install Linny-R in this directory, first create it:
48
48
 
49
- ``npm install --prefix WORKING_DIRECTORY linny-r``
49
+ ``mkdir WORKING_DIRECTORY``
50
50
 
51
- `WORKING_DIRECTORY` should now contain a new sub-directory `node_modules`,
52
- and two JSON files `package.json` and `package-lock.json` that should **not** be removed,
53
- or you will have to re-install Linny-R.
51
+ then change to it:
54
52
 
55
- After installation has been completed, `WORKING_DIRECTORY` will also contain a script file
56
- to facilitate (single click) launch: on a macOS machine the shell script `linny-r.command`,
57
- on a Windows machine the batch script `linny-r.bat`. By default, this script file contains
58
- two commands: change to the Linny-R directory and then tell Node.js to launch the
59
- start the Linny-R server. When configuring Linny-R for a network environment
60
- where individual users each have their personal work space (e.g., a virtual drive U:),
61
- you must edit the script file, adding the argument `workspace=path/to/workspace` to the
62
- `node` command. This will instruct Linny-R to create the `user` directory in this workspace
63
- directory instead of the Linny-R directory.
53
+ ``cd WORKING_DIRECTORY``
54
+
55
+ and then type at the command line prompt:
56
+
57
+ ``npm install --prefix . linny-r``
64
58
 
65
59
  After installation has completed, `WORKING_DIRECTORY` should have this directory tree structure:
66
60
 
@@ -84,11 +78,22 @@ WORKING_DIRECTORY
84
78
  +-sounds
85
79
  </pre>
86
80
 
81
+ `WORKING_DIRECTORY` should contain two JSON files `package.json` and `package-lock.json`
82
+ that should **not** be removed, or you will have to re-install Linny-R. It should also contain
83
+ a script file to facilitate (single click) launch: on a macOS machine the shell script `linny-r.command`,
84
+ on a Windows machine the batch script `linny-r.bat`. By default, this script file contains
85
+ two commands: first change to the Linny-R directory and then tell Node.js to launch the
86
+ start the Linny-R server.
87
+
88
+ **NOTE:** When configuring Linny-R for a network environment where individual users
89
+ each have their personal work space (e.g., a virtual drive U:), you must edit this script file,
90
+ adding the argument `workspace=path/to/workspace` to the `node` command.
91
+ This will instruct Linny-R to create the `user` directory in this workspace directory
92
+ instead of the Linny-R directory.
93
+
87
94
  The `linny-r` directory should contain this file `README.md`,
88
95
  the files `server.js` and `console.js` that will be run by Node.js,
89
- and the sub-directory `static`.
90
-
91
- The `static` directory should contain three HTML files:
96
+ and the sub-directory `static`. This `static` directory should contain three HTML files:
92
97
 
93
98
  * `index.html` (the browser-based GUI)
94
99
  * `show-png.html` (to render SVG diagrams as PNG images)
@@ -155,31 +160,21 @@ If you reach this stage, Linny-R will be able to run LP_solve.
155
160
 
156
161
  ### Running Linny-R
157
162
 
158
- Open the Command Line Interface (CLI) of your computer.
159
- On macOS, open `Terminal`, change to your `WORKING_DIRECTORY` and type:
163
+ Open the Command Line Interface (CLI) of your computer, change to your `WORKING_DIRECTORY` and type:
160
164
 
161
- ``node node_modules/linny-r/server``
165
+ ``linny-r``
162
166
 
163
- On Windows, open `Command Prompt`, change to your `WORKING_DIRECTORY` and type:
164
-
165
- ``node node_modules\linny-r\server``
166
-
167
- The response should be something similar to:
167
+ This response should be something similar to:
168
168
 
169
169
  <pre>
170
170
  Node.js server for Linny-R version 1.0
171
- Node.js version: v18.9.0
172
- </pre>
173
-
174
- followed by some data on your Linny-R configuration.
175
- The last line will be something like:
176
-
177
- <pre>
178
- Listening at: http://127.0.0.1:5050
171
+ Node.js version: v18.10.0
172
+ ... etc.
179
173
  </pre>
180
174
 
181
- Open your web browser and navigate to the given URL, which by default will be http://127.0.0.1:5050.
182
- The Linny-R GUI should then appear in your browser window,
175
+ Meanwhile, your default web browser should have opened a tab for the local server URL,
176
+ which by default will be http://127.0.0.1:5050.
177
+ The Linny-R GUI should show in your browser window,
183
178
  while in the CLI you should see a long series of server log messages like:
184
179
 
185
180
  <pre>
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "linny-r",
3
- "version": "1.1.5",
3
+ "version": "1.1.6",
4
4
  "description": "Executable graphical language with WYSIWYG editor for MILP models",
5
5
  "main": "server.js",
6
6
  "scripts": {
7
- "post-install": "post-install.js",
7
+ "postinstall": "post-install.js",
8
8
  "test": "echo \"Error: no test specified\" && exit 1"
9
9
  },
10
10
  "dependencies": {