diff --git a/README.md b/README.md new file mode 100644 index 0000000..d25451f --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# The Den Development Wiki + +An mdbook-based developer documentation website for The Den's rebase. + +## Website + +You can find the site at https://docs.denstation.net + +## Prerequisites +There's a few things you have to do before you get started on contributing. + +1. Download [Rust](https://rustup.rs) +2. Open your commandline of choice +3. Run ``cargo install mdbook mdbook-pagetoc mdbook-admonish mdbook-linkcheck mdbook-template`` +4. Fork this repository +5. Find a folder you'd want to put this repository in; it can go anywhere you want. +6. On Windows: shift right-click an empty spot inside the file explorer. +7. Click ``Open PowerShell window here`` +8. Run ``git clone link-to-your-fork`` \ No newline at end of file