Update README.md

pull/11/head
Dave Conway-Jones 2019-10-24 09:38:26 +01:00
rodzic 2245a3c579
commit 7f914a8430
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 302A6725C594817F
1 zmienionych plików z 11 dodań i 5 usunięć

Wyświetl plik

@ -12,7 +12,7 @@ This project uses the **electron-builder** project to help build native versions
of Node-RED applications, so please read and become familiar with their [documentation](https://www.electron.build/) as some basic
knowledge is assumed.
As a pre-req, as well as a recent version of node.js, you will need the yarn install tool
As a pre-req, as well as a recent version of node.js, you will need the **yarn** install tool
```bash
# Clone this repository
@ -33,10 +33,11 @@ yarn && yarn dist
```
to create a runtime for your local platform.
However - there may be some errors. If so they are usually fairly self explanatory, and may just require
installation of another npm or brew or apt package, then retry the command.
However - there may be some errors. If so they are usually fairly self explanatory,
and may just require installation of another npm or brew or apt package,
then retry the command.
Runtimes are created in the `dist` directory under `electron-node-red`.
Runtimes are created in the `dist` directory under the `electron-node-red` project.
### Building for other platforms
@ -54,7 +55,7 @@ The defaults are to build a `.msi` for Windows, a `.dmg` for Mac and both a `.de
These can be changed by editing the build section of the `package.json` file, see the
[electron-builder config docs](https://www.electron.build/configuration/configuration) for more info.
## Running localy
## Running locally
While developing and testing you can just run locally by running
```
@ -62,4 +63,9 @@ npm start
```
from within the project folder.
The initial flow file is named `electronflow.json` along with it's credentials file
`electronflow_cred.json`. Just copy your existing flow in instead.
The default is to start on the dashboard page - as this intended to be just an application - without the Node-RED editor exposed to the end user.
---