Skip to content

Commit a0dd6c5

Browse files
committed
Update docs
1 parent 01a96bb commit a0dd6c5

File tree

4 files changed

+20
-30
lines changed

4 files changed

+20
-30
lines changed

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,9 @@ was written correctly, and much more. It can also directly flash Raspberry Pi de
1717

1818
## Supported Operating Systems
1919

20-
- Linux (most distros)
21-
- macOS 10.10 (Yosemite) and later
22-
- Microsoft Windows 7 and later
23-
24-
**Note**: Etcher will run on any platform officially supported by
25-
[Electron][electron]. Read more in their
26-
[documentation][electron-supported-platforms].
20+
- Linux; most distros; Intel 64-bit.
21+
- Windows 10 and later; Intel 64-bit.
22+
- macOS 10.13 (High Sierra) and later; both Intel and Apple Silicon.
2723

2824
## Installers
2925

docs/CONTRIBUTING.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,7 @@ cd etcher
7575
#### GUI
7676

7777
```sh
78-
# Build the GUI
79-
npm run webpack #or npm run build
80-
# Start Electron
78+
# Build and start application
8179
npm start
8280
```
8381

@@ -104,7 +102,6 @@ systems as they can before sending a pull request.
104102
*The test suite is run automatically by CI servers when you send a pull
105103
request.*
106104

107-
108105
We make use of [EditorConfig] to communicate indentation, line endings and
109106
other text editing default. We encourage you to install the relevant plugin in
110107
your text editor of choice to avoid having to fix any issues during the review
@@ -113,7 +110,8 @@ process.
113110
Updating a dependency
114111
---------------------
115112

116-
- Commit *both* `package.json` and `package-lock.json`.
113+
- Install new version of dependency using npm
114+
- Commit *both* `package.json` and `npm-shrinkwrap.json`.
117115

118116
Diffing Binaries
119117
----------------

docs/MAINTAINERS.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -58,30 +58,23 @@ export ANALYTICS_AMPLITUDE_TOKEN="xxxxxx"
5858

5959
##### Clean dist folder
6060

61-
**NOTE:** Make sure to adjust the path as necessary (here the Etcher repository has been cloned to `/home/$USER/code/etcher`)
61+
Delete `.webpack` and `out/`.
6262

6363
##### Generating artifacts
6464

6565
The artifacts are generated by the CI and published as draft-release or pre-release.
66-
`electron-builder` is used to create the packaged application.
66+
Etcher is built with electron-forge. Run:
6767

68-
#### Mac OS
69-
70-
**ATTENTION:** For production releases you'll need the code-signing key,
71-
and set `CSC_NAME` to generate signed binaries on Mac OS.
72-
73-
#### Windows
74-
75-
**ATTENTION:** For production releases you'll need the code-signing key,
76-
and set `CSC_LINK`, and `CSC_KEY_PASSWORD` to generate signed binaries on Windows.
68+
```
69+
npm run make
70+
```
7771

78-
**NOTE:**
79-
- Keep in mind to also generate artifacts for x86, with `TARGET_ARCH=x86`.
72+
Our CI will appropriately sign artifacts for macOS and some Windows targets.
8073

8174

8275
### Uploading packages to Cloudfront
8376

84-
Log in to cloudfront and upload the `rpm` and `deb` files.
77+
Log in to cloudfront and upload the `rpm` and `deb` files.
8578

8679
### Dealing with a Problematic Release
8780

docs/PUBLISHING.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,17 @@ employee by asking for it from the relevant people.
3636
Packaging
3737
---------
3838

39-
The resulting installers will be saved to `dist/out`.
40-
41-
Run the following commands on all platforms with the right arguments:
39+
Run the following command on each platform:
4240

4341
```sh
44-
./node_modules/electron-builder build <...>
42+
npm run make
4543
```
4644

45+
This will produce all targets (eg. zip, dmg) specified in forge.config.ts for the
46+
host platform and architecture.
47+
48+
The resulting artifacts can be found in `out/make`.
49+
4750

4851
Publishing to Cloudfront
4952
---------------------

0 commit comments

Comments
 (0)