Refinements to the README

This started out with the intention to fix a typo in the uninstall 
section of Solus, but developed in to a couple improvements to the 
README.
This commit is contained in:
Jacalz 2019-01-05 16:44:49 +01:00
parent 27ea74722c
commit bf3d069aad

View File

@ -1,5 +1,4 @@
Etcher # Etcher
======
> Flash OS images to SD cards & USB drives, safely and easily. > Flash OS images to SD cards & USB drives, safely and easily.
@ -20,8 +19,7 @@ was written correctly and much more.
![Etcher](https://raw.githubusercontent.com/balena-io/etcher/master/screenshot.png) ![Etcher](https://raw.githubusercontent.com/balena-io/etcher/master/screenshot.png)
Supported Operating Systems ## Supported Operating Systems
---------------------------
- Linux (most distros) - Linux (most distros)
- macOS 10.9 and later - macOS 10.9 and later
@ -31,8 +29,7 @@ Note that Etcher will run on any platform officially supported by
[Electron][electron]. Read more in their [Electron][electron]. Read more in their
[documentation][electron-supported-platforms]. [documentation][electron-supported-platforms].
Installers ## Installers
----------
Refer to the [downloads page][etcher] for the latest pre-made Refer to the [downloads page][etcher] for the latest pre-made
installers for all supported operating systems. installers for all supported operating systems.
@ -41,7 +38,7 @@ installers for all supported operating systems.
1. Add Etcher debian repository: 1. Add Etcher debian repository:
``` ```sh
echo "deb https://deb.etcher.io stable etcher" | sudo tee /etc/apt/sources.list.d/balena-etcher.list echo "deb https://deb.etcher.io stable etcher" | sudo tee /etc/apt/sources.list.d/balena-etcher.list
``` ```
@ -85,14 +82,14 @@ sudo apt-get update
##### Uninstall ##### Uninstall
``` ```sh
sudo yum remove -y balena-etcher-electron sudo yum remove -y balena-etcher-electron
sudo rm /etc/yum.repos.d/etcher-rpm.repo sudo rm /etc/yum.repos.d/etcher-rpm.repo
sudo yum clean all sudo yum clean all
sudo yum makecache fast sudo yum makecache fast
``` ```
or or
``` ```sh
sudo dnf remove -y balena-etcher-electron sudo dnf remove -y balena-etcher-electron
sudo rm /etc/yum.repos.d/etcher-rpm.repo sudo rm /etc/yum.repos.d/etcher-rpm.repo
sudo dnf clean all sudo dnf clean all
@ -101,14 +98,14 @@ sudo dnf makecache
#### Solus (GNU/Linux x64) #### Solus (GNU/Linux x64)
``` ```sh
sudo eopkg it etcher sudo eopkg it etcher
``` ```
##### Uninstall ##### Uninstall
``` ```sh
+sudo eopkg rm etcher sudo eopkg rm etcher
``` ```
#### Brew Cask (macOS) #### Brew Cask (macOS)
@ -138,18 +135,16 @@ choco install etcher
##### Uninstall ##### Uninstall
``` ```sh
choco uninstall etcher choco uninstall etcher
``` ```
Support ## Support
-------
If you're having any problem, please [raise an issue][newissue] on GitHub and If you're having any problem, please [raise an issue][newissue] on GitHub and
the balena.io team will be happy to help. the balena.io team will be happy to help.
License ## License
-------
Etcher is free software, and may be redistributed under the terms specified in Etcher is free software, and may be redistributed under the terms specified in
the [license]. the [license].