Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dfunckt committed Dec 21, 2023
1 parent 01a96bb commit a0dd6c5
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 30 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,9 @@ was written correctly, and much more. It can also directly flash Raspberry Pi de

## Supported Operating Systems

- Linux (most distros)
- macOS 10.10 (Yosemite) and later
- Microsoft Windows 7 and later

**Note**: Etcher will run on any platform officially supported by
[Electron][electron]. Read more in their
[documentation][electron-supported-platforms].
- Linux; most distros; Intel 64-bit.
- Windows 10 and later; Intel 64-bit.

This comment has been minimized.

Copy link
@lurch

lurch Dec 22, 2023

Contributor

@dfunckt Looks like https://etcher.balena.io/#download-etcher needs to be updated to just say "X64" for the latest Windows downloads, rather than "X86|X64" ?

This comment has been minimized.

Copy link
@dfunckt

dfunckt Dec 22, 2023

Author Member

Thanks for pointing this out @lurch. The website is built from the published release sources, it will be updated once 1.19 or later becomes the latest release. I just need it to stay as prerelease a little longer because of the massive changes since last proper release.

- macOS 10.13 (High Sierra) and later; both Intel and Apple Silicon.

## Installers

Expand Down
8 changes: 3 additions & 5 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,7 @@ cd etcher
#### GUI

```sh
# Build the GUI
npm run webpack #or npm run build
# Start Electron
# Build and start application
npm start
```

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


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

- Commit *both* `package.json` and `package-lock.json`.
- Install new version of dependency using npm
- Commit *both* `package.json` and `npm-shrinkwrap.json`.

Diffing Binaries
----------------
Expand Down
21 changes: 7 additions & 14 deletions docs/MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,30 +58,23 @@ export ANALYTICS_AMPLITUDE_TOKEN="xxxxxx"

##### Clean dist folder

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

##### Generating artifacts

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

#### Mac OS

**ATTENTION:** For production releases you'll need the code-signing key,
and set `CSC_NAME` to generate signed binaries on Mac OS.

#### Windows

**ATTENTION:** For production releases you'll need the code-signing key,
and set `CSC_LINK`, and `CSC_KEY_PASSWORD` to generate signed binaries on Windows.
```
npm run make
```

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


### Uploading packages to Cloudfront

Log in to cloudfront and upload the `rpm` and `deb` files.
Log in to cloudfront and upload the `rpm` and `deb` files.

### Dealing with a Problematic Release

Expand Down
11 changes: 7 additions & 4 deletions docs/PUBLISHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,17 @@ employee by asking for it from the relevant people.
Packaging
---------

The resulting installers will be saved to `dist/out`.

Run the following commands on all platforms with the right arguments:
Run the following command on each platform:

```sh
./node_modules/electron-builder build <...>
npm run make
```

This will produce all targets (eg. zip, dmg) specified in forge.config.ts for the
host platform and architecture.

The resulting artifacts can be found in `out/make`.


Publishing to Cloudfront
---------------------
Expand Down

0 comments on commit a0dd6c5

Please sign in to comment.