Skip to content

Commit bcd3f7c

Browse files
committed
update headings
1 parent d51608f commit bcd3f7c

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/01-Getting-Started/2-Installation.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
## Installation
1+
# Installation
22

3-
### Requirements
3+
## Requirements
44

55
**kool** is powered by **Docker**. To use **kool**, you need to **[install the Docker Engine and Docker Compose](https://docs.docker.com/get-docker/)** on your local machine, and make sure they're both running.
66

77
Important to notice: `kool` relies on the `docker` and `docker compose` CLI commands - that being said, you can pick any other Docker-compatibable container engine and use it seamlessly, like OrbStack for example.
88

99
> `kool` now requires [Docker Compose V2](https://docs.docker.com/compose/install/), make sure you have it enabled in your system.
1010
11-
### For Linux and macOS
11+
## For Linux and macOS
1212

1313
Install **kool** by running the following script. It will download the latest **kool** binary from [https://github.com/kool-dev/kool/releases](https://github.com/kool-dev/kool/releases), and save it in your `/usr/local/bin` folder.
1414

1515
```bash
1616
$ curl -fsSL https://kool.dev/install | bash
1717
```
1818

19-
### For Windows
19+
## For Windows
2020

2121
You must run `kool` on Windows via [WSL - Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install) - once you have a WSL environment properly set up, make sure you have [Docker available on it](https://docs.docker.com/desktop/wsl/), then you can install the CLI as you would in any Linux or MacOS (see above).
2222

2323
### Verification
2424

2525
Verify **kool** is installed correctly by running `kool` in your terminal to see a list of available commands.
2626

27-
## Stay Up-to-Date
27+
# Stay Up-to-Date
2828

2929
Update **kool** to a newer version using the `self-update` command. This command will compare your local version with the latest release, and, if a newer version is available, automatically download and install it.
3030

@@ -34,11 +34,11 @@ $ kool self-update
3434

3535
> Sign up for new release notifications and stay up-to-date on our latest features! [Go to our main GitHub repository](https://github.com/kool-dev/kool), click on "Watch" at the top, select the "Custom" option, check "Releases", and hit Apply.
3636
37-
## Autocompletion
37+
# Autocompletion
3838

3939
If you want to use **kool** autocompletion in your Unix shell, follow the appropriate instructions below.
4040

41-
### Bash
41+
## Bash
4242

4343
Temporarily enable autocompletion for your **current session only**:
4444

@@ -62,7 +62,7 @@ $ kool completion bash > /usr/local/etc/bash_completion.d/kool
6262

6363
> After running one of the above commands, remember to start a new shell for autocompletion to take effect.
6464
65-
### Zsh
65+
## Zsh
6666

6767
If Zsh tab completion is not already initialized on your machine, run the following command to turn it on.
6868

@@ -78,7 +78,7 @@ $ kool completion zsh > "${fpath[1]}/_kool"
7878

7979
> After running the above command, remember to start a new shell for autocompletion to take effect.
8080
81-
### Fish
81+
## Fish
8282

8383
Temporarily enable autocompletion for your **current session only**:
8484

0 commit comments

Comments
 (0)