mirror of
https://github.com/balena-io/etcher.git
synced 2025-04-19 12:57:16 +00:00
Update docs
This commit is contained in:
parent
01a96bb6de
commit
a0dd6c5401
10
README.md
10
README.md
@ -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.
|
||||
- macOS 10.13 (High Sierra) and later; both Intel and Apple Silicon.
|
||||
|
||||
## Installers
|
||||
|
||||
|
@ -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
|
||||
```
|
||||
|
||||
@ -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
|
||||
@ -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
|
||||
----------------
|
||||
|
@ -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
|
||||
```
|
||||
npm run make
|
||||
```
|
||||
|
||||
**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.
|
||||
|
||||
**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
|
||||
|
||||
|
@ -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
|
||||
---------------------
|
||||
|
Loading…
x
Reference in New Issue
Block a user