Skip to content

Commit eaa3901

Browse files
authored
docs(README): list all installation methods (#92)
closes #90
1 parent ff9851d commit eaa3901

File tree

1 file changed

+20
-16
lines changed

1 file changed

+20
-16
lines changed

README.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -35,28 +35,33 @@
3535
<img src="assets/mocha.webp"/>
3636
</details>
3737

38-
## Installation
38+
## Usage
3939

40-
### Rust (Preferred)
40+
1. Install the binary using one of the methods below.
4141

42-
1. Install by running `cargo install mdbook-catppuccin` or download the latest [release](https://github.com/catppuccin/mdBook/releases/latest).
42+
| Installation Method | Instructions |
43+
| ------ | ------- |
44+
| **Rust** | `cargo install mdbook-catppuccin` |
45+
| **Homebrew** | `brew install catppuccin/tap/mdbook-catppuccin` |
46+
| **Nix** | `nix run github:catppuccin/mdbook -- install` |
47+
| **GitHub** | Download the [latest release](https://github.com/catppuccin/mdBook/releases/latest) |
48+
| **Manual** | [See below](#manual-installation) |
4349

44-
2. Navigate to your mdBook's root directory (same location where the `book.toml`
45-
lives) and run `mdbook-catppuccin install`
50+
2. Navigate to your mdBook's root directory (same location where the
51+
**book.toml** lives) and run `mdbook-catppuccin install`
4652

47-
3. Build your mdBook using `mdbook build` and enjoy your new catppuccin
48-
flavours!
53+
3. Build using `mdbook build` and enjoy your new catppuccin flavours!
4954

50-
### Manual
55+
### Manual Installation
5156

52-
1. Navigate to `src/bin/assets` within this repository
57+
1. Navigate to [src/bin/assets](./src/bin/assets) within this repository
5358

54-
2. Download all assets: `index.hbs`, `catppuccin.css` and
55-
`catppuccin-admonish.css`
59+
2. Download all assets: [index.hbs](./src/bin/assets/index.hbs),
60+
[catppuccin.css](./src/bin/assets/catppuccin.css) and [catppuccin-admonish.css](./src/bin/assets/catppuccin-admonish.css)
5661

5762
> [!NOTE]
58-
> The `catppuccin-admonish.css` file is **NOT** required if you are not using
59-
> the [mdbook-admonish](https://github.com/tommilligan/mdbook-admonish) plugin.
63+
> The [catppuccin-admonish.css](./src/bin/assets/catppuccin-admonish.css)
64+
> file is **NOT** required if you are not using the [mdbook-admonish](https://github.com/tommilligan/mdbook-admonish) plugin.
6065
6166
3. Transfer downloaded assets to your mdBook's theme directory (the default
6267
directory is `./theme` beside `book.toml`)
@@ -69,8 +74,7 @@
6974
+additional-css = ["./theme/catppuccin.css", "./theme/catppuccin-admonish.css"]
7075
```
7176

72-
5. Build your mdBook using `mdbook build` and enjoy your new catppuccin
73-
flavours!
77+
5. Build using `mdbook build` and enjoy your new catppuccin flavours!
7478

7579
### Version Compatibility
7680

@@ -87,7 +91,7 @@ This table shows the compatibility between the mdBook version and the mdbook-cat
8791
| 1.x.x | 0.4.22 → 0.4.34 |
8892
| 2.x.x | 0.4.35 → latest |
8993

90-
### Development
94+
## Development
9195

9296
1. Clone the repository and navigate to the repository root.
9397

0 commit comments

Comments
 (0)