From 08a85335d853597cc5f7497d89b7c41cb89a9c17 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Tue, 1 May 2018 13:35:40 +0200 Subject: [PATCH] Add more details to readme Signed-off-by: DL6ER --- README.md | 11 +++++++++++ readme.md | 3 --- 2 files changed, 11 insertions(+), 3 deletions(-) create mode 100644 README.md delete mode 100644 readme.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9362d90 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +If you want to work on this repo, you can preview the site as you work. + +Linux Mint / Ubuntu instructions: + +``` +git clone git@github.com:pi-hole/docs.git +cd docs +sudo pip install mkdocs +sudo pip install mkdocs-material +mkdocs serve +``` diff --git a/readme.md b/readme.md deleted file mode 100644 index d4b23b5..0000000 --- a/readme.md +++ /dev/null @@ -1,3 +0,0 @@ -See http://www.mkdocs.org/ for instructions on how to edit/build this site - -Work in progress!!! \ No newline at end of file