Skip to content

Commit 65be184

Browse files
chore: update ref to docs (🤖)
1 parent 65e578c commit 65be184

File tree

6 files changed

+51
-33
lines changed

6 files changed

+51
-33
lines changed

‎docs/latest/.sha

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
e3939f2e608b1b4d05a78b88beece30cc4f718a8
1+
ddee51eb9e5a4bd1306f950755f7b9363d3464f6

‎docs/latest/tutorial/debugging-vscode.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ hide_title: false
77

88
# Debugging in VSCode
99

10-
This guide goes over how to set up VSCode debugging for both your own Electron project as well as the native Electron codebase.
10+
This guide goes over how to set up VSCode debugging for both your own Electron
11+
project as well as the native Electron codebase.
1112

1213
## Debugging your Electron app
1314

@@ -16,8 +17,8 @@ This guide goes over how to set up VSCode debugging for both your own Electron p
1617
#### 1. Open an Electron project in VSCode.
1718

1819
```sh
19-
$ git clone [email protected]:electron/electron-quick-start.git
20-
$ code electron-quick-start
20+
$ npx create-electron-app@latest my-app
21+
$ code my-app
2122
```
2223

2324
#### 2. Add a file `.vscode/launch.json` with the following configuration:
@@ -44,23 +45,27 @@ $ code electron-quick-start
4445

4546
#### 3. Debugging
4647

47-
Set some breakpoints in `main.js`, and start debugging in the [Debug View](https://code.visualstudio.com/docs/editor/debugging). You should be able to hit the breakpoints.
48-
49-
Here is a pre-configured project that you can download and directly debug in VSCode: https://github.com/octref/vscode-electron-debug/tree/master/electron-quick-start
48+
Set some breakpoints in `main.js`, and start debugging in the
49+
[Debug View](https://code.visualstudio.com/docs/editor/debugging). You should
50+
be able to hit the breakpoints.
5051

5152
## Debugging the Electron codebase
5253

53-
If you want to build Electron from source and modify the native Electron codebase, this section will help you in testing your modifications.
54+
If you want to build Electron from source and modify the native Electron codebase,
55+
this section will help you in testing your modifications.
5456

55-
For those unsure where to acquire this code or how to build it, [Electron's Build Tools](https://github.com/electron/build-tools) automates and explains most of this process. If you wish to manually set up the environment, you can instead use these [build instructions](../development/build-instructions-gn.md).
57+
For those unsure where to acquire this code or how to build it,
58+
[Electron's Build Tools](https://github.com/electron/build-tools) automates and
59+
explains most of this process. If you wish to manually set up the environment,
60+
you can instead use these [build instructions](../development/build-instructions-gn.md).
5661

5762
### Windows (C++)
5863

5964
#### 1. Open an Electron project in VSCode.
6065

6166
```sh
62-
$ git clone [email protected]:electron/electron-quick-start.git
63-
$ code electron-quick-start
67+
$ npx create-electron-app@latest my-app
68+
$ code my-app
6469
```
6570

6671
#### 2. Add a file `.vscode/launch.json` with the following configuration:
@@ -93,14 +98,22 @@ $ code electron-quick-start
9398

9499
**Configuration Notes**
95100

96-
* `cppvsdbg` requires the [built-in C/C++ extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) be enabled.
101+
* `cppvsdbg` requires the
102+
[built-in C/C++ extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools)
103+
be enabled.
97104
* `${workspaceFolder}` is the full path to Chromium's `src` directory.
98105
* `your-executable-location` will be one of the following depending on a few items:
99-
* `Testing`: If you are using the default settings of [Electron's Build-Tools](https://github.com/electron/build-tools) or the default instructions when [building from source](../development/build-instructions-gn.md#building).
106+
* `Testing`: If you are using the default settings of
107+
[Electron's Build-Tools](https://github.com/electron/build-tools) or the default
108+
instructions when [building from source](../development/build-instructions-gn.md#building).
100109
* `Release`: If you built a Release build rather than a Testing build.
101-
* `your-directory-name`: If you modified this during your build process from the default, this will be whatever you specified.
102-
* The `args` array string `"your-electron-project-path"` should be the absolute path to either the directory or `main.js` file of the Electron project you are using for testing. In this example, it should be your path to `electron-quick-start`.
110+
* `your-directory-name`: If you modified this during your build process from
111+
the default, this will be whatever you specified.
112+
* The `args` array string `"your-electron-project-path"` should be the absolute
113+
path to either the directory or `main.js` file of the Electron project you are
114+
using for testing. In this example, it should be your path to `my-app`.
103115

104116
#### 3. Debugging
105117

106-
Set some breakpoints in the .cc files of your choosing in the native Electron C++ code, and start debugging in the [Debug View](https://code.visualstudio.com/docs/editor/debugging).
118+
Set some breakpoints in the .cc files of your choosing in the native Electron C++
119+
code, and start debugging in the [Debug View](https://code.visualstudio.com/docs/editor/debugging).

‎docs/latest/tutorial/snapcraft.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ for any Snapcraft environment, including the Ubuntu Software Center.
1212

1313
## Background and Requirements
1414

15-
Together with the broader Linux community, Canonical aims to fix many of the
16-
common software installation problems with the [`snapcraft`](https://snapcraft.io/)
15+
Together with the broader Linux community, Canonical aims to address common
16+
software installation issues through the [`snapcraft`](https://snapcraft.io/)
1717
project. Snaps are containerized software packages that include required
1818
dependencies, auto-update, and work on all major Linux distributions without
1919
system modification.
@@ -90,7 +90,14 @@ snap(options)
9090

9191
### Step 1: Create Sample Snapcraft Project
9292

93-
Create your project directory and add the following to `snap/snapcraft.yaml`:
93+
```sh
94+
$ npx create-electron-app@latest my-app
95+
```
96+
97+
### Step 2: Create Sample Snapcraft Project
98+
99+
Create a `snap` directory in your project root and add the following to
100+
`snap/snapcraft.yaml`:
94101

95102
```yaml
96103
name: electron-packager-hello-world
@@ -104,7 +111,7 @@ grade: stable
104111

105112
apps:
106113
electron-packager-hello-world:
107-
command: electron-quick-start/electron-quick-start --no-sandbox
114+
command: my-app/my-app --no-sandbox
108115
extensions: [gnome]
109116
plugs:
110117
- browser-support
@@ -116,13 +123,13 @@ apps:
116123
TMPDIR: $XDG_RUNTIME_DIR
117124

118125
parts:
119-
electron-quick-start:
126+
my-app:
120127
plugin: nil
121-
source: https://github.com/electron/electron-quick-start.git
128+
source: .
122129
override-build: |
123130
npm install electron @electron/packager
124131
npx electron-packager . --overwrite --platform=linux --output=release-build --prune=true
125-
cp -rv ./electron-quick-start-linux-* $SNAPCRAFT_PART_INSTALL/electron-quick-start
132+
cp -rv ./my-app-linux-* $SNAPCRAFT_PART_INSTALL/my-app
126133
build-snaps:
127134
- node/14/stable
128135
build-packages:
@@ -132,12 +139,10 @@ parts:
132139
- libnspr4
133140
```
134141
135-
If you want to apply this example to an existing project:
136-
137-
- Replace `source: https://github.com/electron/electron-quick-start.git` with `source: .`.
138-
- Replace all instances of `electron-quick-start` with your project's name.
142+
If you want to apply this example to an existing project, replace all instances
143+
of `my-app` with your project's name.
139144

140-
### Step 2: Build the snap
145+
### Step 3: Build the snap
141146

142147
```sh
143148
$ snapcraft
@@ -146,13 +151,13 @@ $ snapcraft
146151
Snapped electron-packager-hello-world_0.1_amd64.snap
147152
```
148153

149-
### Step 3: Install the snap
154+
### Step 4: Install the snap
150155

151156
```sh
152157
sudo snap install electron-packager-hello-world_0.1_amd64.snap --dangerous
153158
```
154159

155-
### Step 4: Run the snap
160+
### Step 5: Run the snap
156161

157162
```sh
158163
electron-packager-hello-world

‎docs/latest/tutorial/tutorial-1-prerequisites.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Prerequisites'
3-
description: 'This guide will step you through the process of creating a barebones Hello World app in Electron, similar to electron/electron-quick-start.'
3+
description: 'This guide will step you through the process of creating a barebones Hello World app in Electron.'
44
slug: tutorial-prerequisites
55
hide_title: false
66
---

‎docs/latest/tutorial/tutorial-2-first-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Building your First App'
3-
description: 'This guide will step you through the process of creating a barebones Hello World app in Electron, similar to electron/electron-quick-start.'
3+
description: 'This guide will step you through the process of creating a barebones Hello World app in Electron.'
44
slug: tutorial-first-app
55
hide_title: false
66
---

‎docs/latest/tutorial/tutorial-3-preload.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Using Preload Scripts'
3-
description: 'This guide will step you through the process of creating a barebones Hello World app in Electron, similar to electron/electron-quick-start.'
3+
description: 'This guide will step you through the process of creating a barebones Hello World app in Electron.'
44
slug: tutorial-preload
55
hide_title: false
66
---

0 commit comments

Comments
 (0)