mirrors/mycorrhiza
1
0
Fork 0
mirror of https://github.com/osmarks/mycorrhiza.git synced 2024-12-12 05:20:26 +00:00
Code Issues Releases Wiki Activity

Edit README.md

Browse Source
This commit is contained in:
bouncepaw 2020-11-27 23:27:50 +05:00
parent c984790d3d
commit a024ba0037
1 changed files with 3 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,18 +1,6 @@
# 🍄 MycorrhizaWiki 0.11
A wiki engine.
Features planned for this release:
* [ ] Authorization
* [x] User groups: `anon`, `editor`, `trusted`, `moderator`, `admin`
* [ ] Login page
* [ ] Rights
* [ ] Mycomarkup improvements
* [x] Strike-through syntax
* [x] Formatting in headings
* [ ] Fix empty line codeblock bug #26
* [ ] `img{}` improvements
* [ ] ...
## Building
```sh
git clone --recurse-submodules https://github.com/bouncepaw/mycorrhiza
@ -27,6 +15,8 @@ make
```
mycorrhiza [OPTIONS...] WIKI_PATH
WIKI_PATH must be a path to git repository which you want to be a wiki.
Options:
-auth-method string
What auth method to use. Variants: "none", "fixed" (default "none")
@ -57,6 +47,7 @@ Options:
* Hyphae can be deleted (while still preserving history)
* Hyphae can be renamed (recursive renaming of subhyphae is also supported)
* Light on resources: I run a home wiki on this engine 24/7 at an [Orange π Lite](http://www.orangepi.org/orangepilite/).
* Authorization with pre-set credentials
## 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.