Skip to content

Commit 9acdd93

Browse files
committed
another update to install docs
1 parent 0f031e1 commit 9acdd93

File tree

1 file changed

+23
-37
lines changed

1 file changed

+23
-37
lines changed

Diff for: README.md

+23-37
Original file line numberDiff line numberDiff line change
@@ -20,51 +20,23 @@ The Boot.dev CLI requires a Golang installation, and only works on Linux and Mac
2020
curl -sS https://webi.sh/golang | sh
2121
```
2222

23-
_read the output of the command and follow any instructions. You might need to update your PATH._
23+
_Read the output of the command and follow any instructions._
2424

2525
**Option 2**: Use the [official installation instructions](https://go.dev/doc/install).
2626

27-
Run `go version` on your command line to make sure the installation worked.
27+
Run `go version` on your command line to make sure the installation worked. If it did, _move on to step 2_.
2828

29-
**Troubleshooting:**
29+
**Optional troubleshooting:**
3030

3131
- If you already had Go installed with webi, you should be able to run the same webi command to update it.
3232
- If you already had a version of Go installed a different way, you can use `which go` to find out where it is installed, and remove the old version manually.
33-
- Check the "troubleshooting command not found" section below if that's the error you're getting.
34-
35-
### 2. Install the Boot.dev CLI
36-
37-
This command will download, build, and install the `bootdev` command into your Go toolchain's `bin` directory. Go ahead and run it:
38-
39-
```bash
40-
go install github.com/bootdotdev/bootdev@latest
41-
```
42-
43-
Make sure that it works by running:
44-
45-
```bash
46-
bootdev help
47-
```
48-
49-
If you're having issues, check the "troubleshooting command not found" section below.
50-
51-
### 3. Login to the CLI
52-
53-
Run `bootdev login` to authenticate with your Boot.dev account. After authenticating, you're ready to go!
54-
55-
### Troubleshooting "command not found"
56-
57-
If you're getting a "command not found" error for either the `go version` or the `bootdev help`, it's most likely because the directory containing the `go` binary isn't in your [`PATH`](https://opensource.com/article/17/6/set-path-linux). You can add the bin directory to your `PATH` by modifying your shell's configuration file. _Also, be sure to read the output of any installation commands you run, as they likely contain important info._
58-
59-
**PATH issues with Go itself**:
60-
61-
You need to know _where_ the `go` command was installed. It might be in:
33+
- If you're getting a "command not found" error after installation, it's most likely because the directory containing the `go` 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. First, you need to know _where_ the `go` command was installed. It might be in:
6234

6335
- `~/.local/opt/go/bin` (webi)
6436
- `/usr/local/go/bin` (official installation)
65-
- somewhere else?
37+
- Somewhere else?
6638

67-
You should be able to ensure it exists by attempting to run `go` with the 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:
39+
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:
6840

6941
```bash
7042
# For Linux/WSL
@@ -80,11 +52,21 @@ echo 'export PATH=$PATH:$HOME/.local/opt/go/bin' >> ~/.zshrc
8052
source ~/.zshrc
8153
```
8254

83-
_Use the correct shell configuration file for your shell, and the correct path to your Go installation._
55+
### 2. Install the Boot.dev CLI
8456

85-
**PATH issues with the Boot.dev CLI**:
57+
This command will download, build, and install the `bootdev` command into your Go toolchain's `bin` directory. Go ahead and run it:
8658

87-
You probably need to add `$HOME/go/bin` (the default `GOBIN` directory where `go` installs programs) to your `PATH`:
59+
```bash
60+
go install github.com/bootdotdev/bootdev@latest
61+
```
62+
63+
Run `go version` on your command line to make sure the installation worked. If it did, _move on to step 3_.
64+
65+
_If it worked, move on to step 3._
66+
67+
**Optional troubleshooting:**
68+
69+
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`:
8870

8971
```bash
9072
# For Linux/WSL
@@ -99,3 +81,7 @@ echo 'export PATH=$PATH:$HOME/go/bin' >> ~/.zshrc
9981
# next, reload your shell configuration
10082
source ~/.zshrc
10183
```
84+
85+
### 3. Login to the CLI
86+
87+
Run `bootdev login` to authenticate with your Boot.dev account. After authenticating, you're ready to go!

0 commit comments

Comments
 (0)