search

ankitects / anki-manual

Anki's manual
https://docs.ankiweb.net
495 stars 173 forks source link

add CONTRIBUTING.md #292

Open joshdavham opened 3 weeks ago

joshdavham commented 3 weeks ago

I had some difficulty figuring out how to build anki-manual my first time and thought it'd be useful to include some instructions for others on how to build it locally, themselves.

I added a CONTRIBUTING.md file with local development instructions and linked to it in the README.md.

The CONTRIBUTING.md file could also probably benefit from some other information as well, such as what types of contributions are generally welcomed, but I thought this'd be a good start for now.

Let me know if there are any questions 👍

brishtibheja commented 3 weeks ago

Maybe add a link to mdBook documentation. https://rust-lang.github.io/mdBook/

joshdavham commented 3 weeks ago

Maybe add a link to mdBook documentation. https://rust-lang.github.io/mdBook/

I did.