Skip to content

Commit

Permalink
add CONTRIBUTING.md (#292)
Browse files Browse the repository at this point in the history
  • Loading branch information
joshdavham authored Nov 18, 2024
1 parent ff8cb8b commit a8f7d31
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 1 deletion.
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing to the Anki manual

## Local development

anki-manual is built using [mdBook](https://rust-lang.github.io/mdBook/), a Rust-based tool for creating webpages using Markdown.

### Install dependencies

In order to use mdBook, please first ensure that you have [Rust](https://www.rust-lang.org/tools/install) installed on your machine.

Next, install mdBook and its pre-processors
```
cargo install mdbook
cargo install mdbook-toc
cargo install mdbook-linkcheck
```

### Develop and preview

To serve anki-manual locally, build the book with

```
mdbook build
```

and then serve anki-manual with

```
mdbook serve --open
```

You can now make changes to the markdown (*.md) files in the `src/` directory and have your changes previewed locally.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ This manual is licensed under the CC BY-SA 4 license:
https://creativecommons.org/licenses/by-sa/4.0/

Pull requests are welcome. Unless you state otherwise, any pull requests you
submit will be licensed under the above license.
submit will be licensed under the above license. Please see [CONTRIBUTING](CONTRIBUTING.md) for more details.

0 comments on commit a8f7d31

Please sign in to comment.