Skip to content

Commit

Permalink
Add install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
John committed Feb 5, 2024
1 parent 64ccc87 commit ad26270
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,15 @@

This is a **Work In Progress**.

`mdbook-utils` manages links, reference definitions, and code examples in Markdown files, especially `mdbook` source directories.
The `mdbook-utils` command-line tool manages links, reference definitions, and code examples in Markdown files, especially `mdbook` source directories.
It is the companion tool for the ["Rust How-to"](https://www.john-cd.com/rust_howto/) book ([github](https://github.com/john-cd/rust_howto)).

## Installation

```bash
cargo install mdbook-utils
```

## Usage

Run the tool without arguments to display the the list of commands:
Expand Down Expand Up @@ -109,7 +115,7 @@ The [`just`](https://just.systems/) command runner is configured to simplify com

Type `just` at a shell prompt for a list of commands:

```bash
```sh
just clean # Clean the `target` folder

just fmt # Format the code
Expand Down

0 comments on commit ad26270

Please sign in to comment.