From 0e6c22080b08d542ed1e77fb89e81969ad742184 Mon Sep 17 00:00:00 2001 From: bouncepaw Date: Tue, 1 Sep 2020 21:52:40 +0500 Subject: [PATCH] A better README.md for 0.8 release --- README.md | 36 ++++++++++++++++++++++++------------ 1 file changed, 24 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 8e9f51b..a733e95 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,35 @@ -# MycorrhizaWiki -A wiki engine inspired by fungi. +# 🍄 MycorrhizaWiki 0.8 +A wiki engine. + +## Installation +```sh +git clone --recurse-submodules https://github.com/bouncepaw/mycorrhiza +cd mycorrhiza +make +# That make will: +# * run the default wiki. You can edit it right away. +# * create an executable called `mycorrhiza`. Run it with path to your wiki. +``` ## Current features * Edit pages through html forms * Responsive design * Works in text browsers -* Pages (called hyphae) are in gemtext +* Wiki pages (called hyphae) are in gemtext * Everything is stored as simple files, no database required * Page trees * Changes are saved to git +* List of hyphae page * History page +* Random page +* Light on resources: I run a home wiki on this engine 24/7 at an [Orange π Lite](http://www.orangepi.org/orangepilite/). -## Future features -* Tags +## Contributing +Help is always needed. We have a [tg chat](https://t.me/mycorrhizadev) where some development is coordinated. Feel free to open an issue or contact me. + +## Future plans +* Tagging system * Authorization -* History view -* Granular user rights -* A better page tree algorithm - -## Installation -I guess you can just clone this repo and run `make` to play around with the default wiki. - +* Better history viewing +* Recent changes page +* More markups