cherry-pick: 4446-readme-fix

Updates #4446.

* commit 'ea5d165a703dd37ef40254f3f775e049b6cebf93':
  all: imp readme
  Enable code block syntax hightlight in README.md
This commit is contained in:
Ainar Garipov 2022-08-18 13:38:10 +03:00 committed by Ainar Garipov
parent 9728dd856f
commit 3fd467413c
1 changed files with 15 additions and 8 deletions

View File

@ -68,8 +68,10 @@ and both share a lot of code.
## Getting Started ## Getting Started
### Automated install (Linux and Mac) ### Automated install (Linux and Mac)
Run the following command in your terminal: Run the following command in your terminal:
```
```sh
curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -v curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -v
``` ```
@ -204,7 +206,7 @@ You will need this to build AdGuard Home:
Open Terminal and execute these commands: Open Terminal and execute these commands:
```bash ```sh
git clone https://github.com/AdguardTeam/AdGuardHome git clone https://github.com/AdguardTeam/AdGuardHome
cd AdGuardHome cd AdGuardHome
make make
@ -222,11 +224,14 @@ Check the [`Makefile`](https://github.com/AdguardTeam/AdGuardHome/blob/master/Ma
In order to do this, specify `GOOS` and `GOARCH` env variables before running make. In order to do this, specify `GOOS` and `GOARCH` env variables before running make.
For example: For example:
```
```sh
env GOOS='linux' GOARCH='arm64' make env GOOS='linux' GOARCH='arm64' make
``` ```
Or:
``` or:
```sh
make GOOS='linux' GOARCH='arm64' make GOOS='linux' GOARCH='arm64'
``` ```
@ -238,7 +243,7 @@ You'll need this to prepare a release build:
Commands: Commands:
``` ```sh
make build-release CHANNEL='...' VERSION='...' make build-release CHANNEL='...' VERSION='...'
``` ```
@ -281,12 +286,14 @@ There are three options how you can install an unstable version:
3. Standalone builds. Use the automated installation script or look for the available builds below. 3. Standalone builds. Use the automated installation script or look for the available builds below.
Beta: Beta:
```
```sh
curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -c beta curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -c beta
``` ```
Edge: Edge:
```
```sh
curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -c edge curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -c edge
``` ```