mirror of
https://github.com/osmarks/mycorrhiza.git
synced 2024-12-13 05:50:27 +00:00
write a better readme
This commit is contained in:
parent
02f6a74c91
commit
24d11c04c2
31
README.md
31
README.md
@ -1,6 +1,31 @@
|
|||||||
# mycorrhiza wiki
|
# mycorrhiza wiki
|
||||||
A wiki engine inspired by fungi.
|
A wiki engine inspired by fungi. Not production-ready.
|
||||||
|
|
||||||
Current version: 0.5.
|
Current version: 0.5 (or more?)
|
||||||
|
|
||||||
Not production-ready.
|
## Current features
|
||||||
|
* Edit pages through html forms
|
||||||
|
* Responsive design
|
||||||
|
* Theme support (no themes other than the default one implemented though)
|
||||||
|
* Works in text browsers
|
||||||
|
* Pages (called hyphae) can be written in markdown, creole or geminitext.
|
||||||
|
* Two types of plugins: parsers (for supporting more markup languages) and languages (for i18n)
|
||||||
|
* Change history is saved and can be viewed (no nice way to do this yet, it can be done by changing url only)
|
||||||
|
* Namespaces called mycelia
|
||||||
|
* Everything is stored as simple files, no database required
|
||||||
|
|
||||||
|
## Future features
|
||||||
|
* Tags
|
||||||
|
* Authorization
|
||||||
|
* History view
|
||||||
|
* Granular user rights
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
I guess you can just clone this repo and run `make` to play around with the default wiki.
|
||||||
|
|
||||||
|
## License
|
||||||
|
Contents of `wiki` directory are under CC BY-SA 4.0.
|
||||||
|
|
||||||
|
File `wiki/favicon.icon` is from [here](https://thenounproject.com/search/?q=mushroom&i=990340).
|
||||||
|
|
||||||
|
The license for the rest of files is not decided yet, so let's consider it to be CC BY-SA 4.0 too.
|
||||||
|
Loading…
Reference in New Issue
Block a user