Skip to content

Commit 61713e8

Browse files
committed
add missing README.md, update .vscodeignore
1 parent 9c47f39 commit 61713e8

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

src/.vscodeignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
**
22

33
!package.json
4-
!dist/
4+
!dist/vscode-electron.js
5+
!README.MD

src/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Install Electron via VSCode extension
2+
3+
Install or Executes Electon apps inside of vscode
4+
5+
## Motivation
6+
7+
If an extension is to be created which displays a dialog with the help of Electron, or is to call up a session cookie, this is currently only possible with great difficulty because it is not possible to install electron via the package.json.
8+
9+
1. Option we could deliver Electron which leads
10+
1. to a very large extension and more importantly
11+
2. the electron binaries are OS specific. So if I installed the extension on a Windows there is electron for Windows inside.
12+
2. Option Hope that Electron is installed globally, otherwise it won't work.
13+
3. Option is to compile the app beforehand, but this must be done separately for Mac, Windows and Linux.
14+
15+
The aim of this extension is to solve precisely those problems.
16+
17+
1. It is checked whether an Electron is available (global) or with Mac whether it is installed under Applications.
18+
2. If it is not installed, the OS-specific version of Electron is downloaded for Mac, Windows or Linux, thus ensuring platform independence.
19+
20+
Furthermore, javascript files can now be started directly via vscode in electron so the files no longer have to be compiled.
21+
22+
## Usage
23+
24+
This is more designed as a service, that means you can install electron but it will not help alot. These is an example how this could be used inside your extension @see [Vscode-Electron-Demo](https://github.com/q-masters/vscode-electron-demo) how this could be used inside an extension.
25+
26+
## Commands
27+
28+
|name|params|description|
29+
|-|-|-|
30+
|qmasters:electron.install|-|checks for a valid installation and install electron is nothing exists|
31+
|qmasters:electron.run|file path|file to execute [@example](https://github.com/electron/electron-quick-start/blob/master/main.js)|
32+
33+
## Development
34+
35+
- go into src directory
36+
- npm install
37+
- start extension via F5 inside of vscode

0 commit comments

Comments
 (0)