mirrors/mycorrhiza
1
0
Fork 0
mirror of https://github.com/osmarks/mycorrhiza.git synced 2025-01-07 10:20:26 +00:00
Code Issues Releases Wiki Activity

A better README.md for 0.8 release

Browse Source
This commit is contained in:
bouncepaw 2020-09-01 21:52:40 +05:00
parent 756b97f644
commit 0e6c22080b
1 changed files with 24 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -1,23 +1,35 @@
# MycorrhizaWiki # 🍄 MycorrhizaWiki 0.8
A wiki engine inspired by fungi. 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 ## Current features
* Edit pages through html forms * Edit pages through html forms
* Responsive design * Responsive design
* Works in text browsers * 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 * Everything is stored as simple files, no database required
* Page trees * Page trees
* Changes are saved to git * Changes are saved to git
* List of hyphae page
* History 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 ## Contributing
* Tags 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 * Authorization
* History view * Better history viewing
* Granular user rights * Recent changes page
* A better page tree algorithm * More markups
## Installation
I guess you can just clone this repo and run `make` to play around with the default wiki.