From 15703886da296171ce4646da3e1e2e2fca594de5 Mon Sep 17 00:00:00 2001 From: CryptoGrampy Date: Sun, 14 Nov 2021 17:17:16 -0600 Subject: [PATCH] Add README.md with MoneroDocs local setup guide --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..17b0dff --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# MoneroDocs + +- [MoneroDocs](#monerodocs) + - [About](#about) + - [Contributing](#contributing) + +## About + +Monerodocs attempts to organize basic technical knowledge on Monero in one place. + +While technical explanations are out there, knowledge is scattered through reddit posts, git comments, stack exchange answers, chat logs and the source code. This makes it hard to find complete and up-to-date explanations on advanced topics. + +The goal is to educate and onboard power users faster. + +## Contributing + +To contribute to MoneroDocs, you'll need to setup your local [Mkdocs-Material](https://squidfunk.github.io/mkdocs-material/) environment: + +```sh +# Fork the monerodocs/md Github repo + +# Clone your newly created repo- be sure to include the submodule flag +git clone --recurse-submodules git@github.com:your-user-name/md.git + +cd md + +# Install mkdocs dependencies +pip install mkdocs-material mkdocs-minify-plugin + +# Run the documentation server locally +python3 -m mkdocs serve +```