8000 docs: update remaining references to `electron-quick-start` (#47449) · electron/electron@ddee51e · GitHub
[go: up one dir, main page]
Skip to content

Commit ddee51e

Browse files
trop[bot]yangannyx
trop[bot]
and
yangannyx
authored
docs: update remaining references to electron-quick-start (#47449)
* chore: udpate remaining references to electron-quick-start Co-authored-by: Anny Yang <yangannyx@gmail.com> * chore: Update docs/tutorial/tutorial-1-prerequisites.md Co-authored-by: Niklas Wenzel <dev@nikwen.de> Co-authored-by: Anny Yang <anny@electronjs.org> * chore: Update docs/tutorial/tutorial-3-preload.md Co-authored-by: Niklas Wenzel <dev@nikwen.de> Co-authored-by: Anny Yang <anny@electronjs.org> * chore: Update docs/tutorial/tutorial-2-first-app.md Co-authored-by: Niklas Wenzel <dev@nikwen.de> Co-authored-by: Anny Yang <anny@electronjs.org> * chore: linebreak Co-authored-by: Anny Yang <yangannyx@gmail.com> * chore: swap minimal-repro for npx create-electron-app Co-authored-by: Anny Yang <yangannyx@gmail.com> * chore: add back code commands Co-authored-by: Anny Yang <yangannyx@gmail.com> * chore: add whitespace Co-authored-by: Anny Yang <yangannyx@gmail.com> * chore: remove reference to repo containing old quick start Co-authored-by: Anny Yang <yangannyx@gmail.com> --------- Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com> Co-authored-by: Anny Yang <yangannyx@gmail.com> Co-authored-by: Anny Yang <anny@electronjs.org>
1 parent 351e6e3 commit ddee51e

File tree

5 files changed

+50
-32
lines changed

5 files changed

+50
-32
lines changed

‎docs/tutorial/debugging-vscode.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Debugging in VSCode
22

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

56
## Debugging your Electron app
67

@@ -9,8 +10,8 @@ This guide goes over how to set up VSCode debugging for both your own Electron p
910
#### 1. Open an Electron project in VSCode.
1011

1112
```sh
12-
$ git clone git@github.com:electron/electron-quick-start.git
13-
$ code electron-quick-start
13+
$ npx create-electron-app@latest my-app
14+
$ code my-app
1415
```
1516

1617
#### 2. Add a file `.vscode/launch.json` with the following configuration:
@@ -37,23 +38,27 @@ $ code electron-quick-start
3738

3839
#### 3. Debugging
3940

40-
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.
41-
42-
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
41+
Set some breakpoints in `main.js`, and start debugging in the
42+
[Debug View](https://code.visualstudio.com/docs/editor/debugging). You should
43+
be able to hit the breakpoints.
4344

4445
## Debugging the Electron codebase
4546

46-
If you want to build Electron from source and modify the native Electron codebase, this section will help you in testing your modifications.
47+
If you want to build Electron from source and modify the native Electron codebase,
48+
this section will help you in testing your modifications.
4749

48-
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).
50+
For those unsure where to acquire this code or how to build it,
51+
[Electron's Build Tools](https://github.com/electron/build-tools) automates and
52+
explains most of this process. If you wish to manually set up the environment,
53+
you can instead use these [build instructions](../development/build-instructions-gn.md).
4954

5055
### Windows (C++)
5156

5257
#### 1. Open an Electron project in VSCode.
5358

5459
```sh
55-
$ git clone git@github.com:electron/electron-quick-start.git
56-
$ code electron-quick-start
60+
$ npx create-electron-app@latest my-app
61+
$ code my-app
5762
```
5863

5964
#### 2. Add a file `.vscode/launch.json` with the following configuration:
@@ -86,14 +91,22 @@ $ code electron-quick-start
8691

8792
**Configuration Notes**
8893

89-
* `cppvsdbg` requires the [built-in C/C++ extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) be enabled.
94+
* `cppvsdbg` requires the
95+
[built-in C/C++ extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools)
96+
be enabled.
9097
* `${workspaceFolder}` is the full path to Chromium's `src` directory.
9198
* `your-executable-location` will be one of the following depending on a few items:
92-
* `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).
99+
* `Testing`: If you are using the default settings of
100+
[Electron's Build-Tools](https://github.com/electron/build-tools) or the default
101+
instructions when [building from source](../development/build-instructions-gn.md#building).
93102
* `Release`: If you built a Release build rather than a Testing build.
94-
* `your-directory-name`: If you modified this during your build process from the default, this will be whatever you specified.
95-
* 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`.
103+
* `your-directory-name`: If you modified this during your build process from
104+
the default, this will be whatever you specified.
105+
* The `args` array string `"your-electron-project-path"` should be the absolute
106+
path to either the directory or `main.js` file of the Electron project you are
107+
using for testing. In this example, it should be your path to `my-app`.
96108

97109
#### 3. Debugging
98110

99-
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).
111+
Set some breakpoints in the .cc files of your choosing in the native Electron C++
112+
code, and start debugging in the [Debug View](https://code.visualstudio.com/docs/editor/debugging).

‎docs/tutorial/snapcraft.md

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

66
## Background and Requirements
77

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

8484
### Step 1: Create Sample Snapcraft Project
8585

86-
Create your project directory and add the following to `snap/snapcraft.yaml`:
86+
```sh
87+
$ npx create-electron-app@latest my-app
88+
```
89+
90+
### Step 2: Create Sample Snapcraft Project
91+
92+
Create a `snap` directory in your project root and add the following to
93+
`snap/snapcraft.yaml`:
8794

8895
```yaml
8996
name: electron-packager-hello-world
@@ -97,7 +104,7 @@ grade: stable
97104

98105
apps:
99106
electron-packager-hello-world:
100-
command: electron-quick-start/electron-quick-start --no-sandbox
107+
command: my-app/my-app --no-sandbox
101108
extensions: [gnome]
102109
plugs:
103110
- browser-support
@@ -109,13 +116,13 @@ apps:
109116
TMPDIR: $XDG_RUNTIME_DIR
110117

111118
parts:
112-
electron-quick-start:
119+
my-app:
113120
plugin: nil
114-
source: https://github.com/electron/electron-quick-start.git
121+
source: .
115122
override-build: |
116123
npm install electron @electron/packager
117124
npx electron-packager . --overwrite --platform=linux --output=release-build --prune=true
118-
cp -rv ./electron-quick-start-linux-* $SNAPCRAFT_PART_INSTALL/electron-quick-start
125+
cp -rv ./my-app-linux-* $SNAPCRAFT_PART_INSTALL/my-app
119126
build-snaps:
120127
- node/14/stable
121128
build-packages:
@@ -125,12 +132,10 @@ parts:
125132
- libnspr4
126133
```
127134
128-
If you want to apply this example to an existing project:
129-
130-
- Replace `source: https://github.com/electron/electron-quick-start.git` with `source: .`.
131-
- Replace all instances of `electron-quick-start` with your project's name.
135+
If you want to apply this example to an existing project, replace all instances
136+
of `my-app` with your project's name.
132137

133-
### Step 2: Build the snap
138+
### Step 3: Build the snap
134139

135140
```sh
136141
$ snapcraft
@@ -139,13 +144,13 @@ $ snapcraft
139144
Snapped electron-packager-hello-world_0.1_amd64.snap
140145
```
141146

142-
### Step 3: Install the snap
147+
### Step 4: Install the snap
143148

144149
```sh
145150
sudo snap install electron-packager-hello-world_0.1_amd64.snap --dangerous
146151
```
147152

148-
### Step 4: Run the snap
153+
### Step 5: Run the snap
149154

150155
```sh
151156
electron-packager-hello-world

‎docs/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/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
---
< 7FA6 div class="Diff-module__diffHeaderWrapper--rsdD4" style="--header-sticky-offset:0px">

‎docs/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)
0