Updated the README with the build step.

From now on, Electron `4.x` is used for the dev.
Otherwise, we could not use `@grpc/grpc-js`.

Signed-off-by: Akos Kitta <kittaakos@typefox.io>

.gitignore

@@ -7,4 +7,6 @@ build/
 src-gen/
 arduino-ide-*/webpack.config.js
 .DS_Store
-/workspace/static
+/workspace/static
+# switching from `electron` to `browser` in dev mode.
+.browser_modules

README.md

@@ -11,11 +11,21 @@ It's built on top of a [fork of the arduino-cli](https://github.com/typefox/ardu
 
 ```
 git clone https://github.com/bcmi-labs/arduino-editor
-cd arduino-poc
+cd arduino-editor
 yarn
+yarn rebuild:electron
 yarn --cwd arduino-ide-electron start
 ```
 
+If you want to switch back to the browser-based example, execute the following in the repository root
+```
+yarn rebuild:browser
+```
+Then you can start the browser example again:
+```
+yarn --cwd arduino-ide-browser start
+```
+
 ## Arduino-PoC Electron Application
  - The project is built on [Azure DevOps](https://dev.azure.com/typefox/Arduino).
  - The configured pipelines are available [here](https://dev.azure.com/typefox/Arduino/_build?definitionId=4).

arduino-ide-electron/package.json

@@ -21,7 +21,8 @@
         "arduino-ide-extension": "0.0.1"
     },
     "devDependencies": {
-        "@theia/cli": "next"
+        "@theia/cli": "next",
+        "electron": "^4.2.0"
     },
     "scripts": {
         "prepare": "theia build --mode development",

package.json

@@ -12,6 +12,8 @@
   },
   "scripts": {
       "prepare": "lerna run prepare",
+      "rebuild:browser": "theia rebuild:browser",
+      "rebuild:electron": "theia rebuild:electron",
       "start": "cd arduino-ide-browser && yarn start"
   },
   "workspaces": [

yarn.lock

@@ -1287,6 +1287,11 @@
   resolved "https://registry.yarnpkg.com/@types/node/-/node-12.0.0.tgz#d11813b9c0ff8aaca29f04cbc12817f4c7d656e5"
   integrity sha512-Jrb/x3HT4PTJp6a4avhmJCDEVrPdqLfl3e8GGMbpkGGdwAV5UGlIs4vVEfsHHfylZVOKZWpOqmqFH8CbfOZ6kg==
 
+"@types/node@^10.12.18":
+  version "10.14.6"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-10.14.6.tgz#9cbfcb62c50947217f4d88d4d274cc40c22625a9"
+  integrity sha512-Fvm24+u85lGmV4hT5G++aht2C5I4Z4dYlWZIh62FAfFO/TfzXtPpoLI6I7AuBWkIFqZCnhFOoTT7RjjaIL5Fjg==
+
 "@types/node@^8.0.24":
   version "8.10.48"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-8.10.48.tgz#e385073561643a9ba6199a1985ffc03530f90781"
@@ -4473,6 +4478,15 @@ electron@^3.1.7:
     electron-download "^4.1.0"
     extract-zip "^1.0.3"
 
+electron@^4.2.0:
+  version "4.2.0"
+  resolved "https://registry.yarnpkg.com/electron/-/electron-4.2.0.tgz#6066c7660597020365ee4427aa35260f23a678c9"
+  integrity sha512-bn41xAekJ8h4QfMwmlsL3Qx1xUloTwVHBEKRg8hGDhecfdPgDdps60gfoZOhdL88avimahrP01Bd7Aijsyywdg==
+  dependencies:
+    "@types/node" "^10.12.18"
+    electron-download "^4.1.0"
+    extract-zip "^1.0.3"
+
 elegant-spinner@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/elegant-spinner/-/elegant-spinner-1.0.1.tgz#db043521c95d7e303fd8f345bedc3349cfb0729e"