Skip to content

Commit 6bb7eab

Browse files
edit readme
1 parent 7e6b925 commit 6bb7eab

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Boot.dev CLI requires an up-to-date Golang installation, and only works on L
1616

1717
**Option 1**: [The webi installer](https://webinstall.dev/golang/) is the simplest way for most people. Just run this in your terminal:
1818

19-
```bash
19+
```sh
2020
curl -sS https://webi.sh/golang | sh
2121
```
2222

@@ -38,14 +38,14 @@ Run `go version` on your command line to make sure the installation worked. If i
3838

3939
You can ensure it exists by attempting to run `go` using its full filepath. For example, if you think it's in `~/.local/opt/go/bin`, you can run `~/.local/opt/go/bin/go version`. If that works, then you just need to add `~/.local/opt/go/bin` to your `PATH` and reload your shell:
4040

41-
```bash
41+
```sh
4242
# For Linux/WSL
4343
echo 'export PATH=$PATH:$HOME/.local/opt/go/bin' >> ~/.bashrc
4444
# next, reload your shell configuration
4545
source ~/.bashrc
4646
```
4747

48-
```bash
48+
```sh
4949
# For Mac OS
5050
echo 'export PATH=$PATH:$HOME/.local/opt/go/bin' >> ~/.zshrc
5151
# next, reload your shell configuration
@@ -56,7 +56,7 @@ source ~/.zshrc
5656

5757
This command will download, build, and install the `bootdev` command into your Go toolchain's `bin` directory. Go ahead and run it:
5858

59-
```bash
59+
```sh
6060
go install github.com/bootdotdev/bootdev@latest
6161
```
6262

@@ -66,14 +66,14 @@ Run `bootdev --version` on your command line to make sure the installation worke
6666

6767
If you're getting a "command not found" error for `bootdev help`, it's most likely because the directory containing the `bootdev` program isn't in your [`PATH`](https://opensource.com/article/17/6/set-path-linux). You need to add the directory to your `PATH` by modifying your shell's configuration file. You probably need to add `$HOME/go/bin` (the default `GOBIN` directory where `go` installs programs) to your `PATH`:
6868

69-
```bash
69+
```sh
7070
# For Linux/WSL
7171
echo 'export PATH=$PATH:$HOME/go/bin' >> ~/.bashrc
7272
# next, reload your shell configuration
7373
source ~/.bashrc
7474
```
7575

76-
```bash
76+
```sh
7777
# For Mac OS
7878
echo 'export PATH=$PATH:$HOME/go/bin' >> ~/.zshrc
7979
# next, reload your shell configuration
@@ -86,7 +86,7 @@ Run `bootdev login` to authenticate with your Boot.dev account. After authentica
8686

8787
## Configuration
8888

89-
The Boot.dev CLI offers a couple of configuration options that are stored in a config file (default is `~/.bootdev.yaml`).
89+
The Boot.dev CLI offers a couple of configuration options that are stored in a config file (default is `~/.bootdev.yaml`, or `$XDG_CONFIG_HOME/bootdev/config.yaml` if `XDG_CONFIG_HOME` is set).
9090

9191
All commands have `-h`/`--help` flags if you want to see available options on the command line.
9292

@@ -96,44 +96,44 @@ For lessons with HTTP tests, you can configure the CLI with a base URL that over
9696

9797
- To set the base URL run:
9898

99-
```bash
100-
bootdev config base_url <url>
101-
```
99+
```sh
100+
bootdev config base_url <url>
101+
```
102102

103-
_Make sure you include the protocol scheme (`http://`) in the URL._
103+
_Make sure you include the protocol scheme (`http://`) in the URL._
104104

105105
- To get the current base URL (the default is an empty string), run:
106106

107-
```bash
108-
bootdev config base_url
109-
```
107+
```sh
108+
bootdev config base_url
109+
```
110110

111111
- To reset the base URL and revert to using the lessons' defaults, run:
112112

113-
```bash
114-
bootdev config base_url --reset
115-
```
113+
```sh
114+
bootdev config base_url --reset
115+
```
116116

117117
### CLI colors
118118

119119
The CLI text output is rendered with extra colors: green (e.g., success messages), red (e.g., error messages), and gray (e.g., secondary text).
120120

121121
- To customize these colors, run:
122122

123-
```bash
124-
bootdev config colors --red <value> --green <value> --gray <value>
125-
```
123+
```sh
124+
bootdev config colors --red <value> --green <value> --gray <value>
125+
```
126126

127-
_You can use an [ANSI color code](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) or a hex string as the `<value>`._
127+
_You can use an [ANSI color code](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) or a hex string as the `<value>`._
128128

129129
- To get the current colors, run:
130130

131-
```bash
132-
bootdev config colors
133-
```
131+
```sh
132+
bootdev config colors
133+
```
134134

135135
- To reset the colors to their default values, run:
136136

137-
```bash
138-
bootdev config colors --reset
139-
```
137+
```sh
138+
bootdev config colors --reset
139+
```

0 commit comments

Comments
 (0)