mirrors/mycorrhiza
1
0
Fork 0
mirror of https://github.com/osmarks/mycorrhiza.git synced 2024-10-30 11:46:16 +00:00
Code Issues Releases Wiki Activity

Merge pull request #60 from Astrr/patch-2

Browse Source 
Fix typos and a bit of wording change in readme
This commit is contained in:
Timur Ismagilov 2021-05-28 22:56:54 +05:00 committed by GitHub
commit 75867a1e58
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -16,7 +16,7 @@ make
## Installing
If you use linux disto with pacman package manager (Arch, Manjaro, Garuda, etc) you can install it from PKGBUILD:
If you use a linux distro with pacman package manager (Arch, Manjaro, Garuda, etc) you can install it using PKGBUILD:
```sh
$ wget https://raw.githubusercontent.com/bouncepaw/mycorrhiza/master/PKGBUILD
$ makepkg --install
@ -26,7 +26,7 @@ $ makepkg --install
```
mycorrhiza [OPTIONS...] WIKI_PATH
WIKI_PATH must be a path to git repository which you want to be a wiki.
WIKI_PATH must be a path to a git repository which you want to be a wiki.
Options:
-config-path string
@ -37,7 +37,7 @@ Options:
## Features
* Wiki pages (called hyphae) are written in mycomarkup
* Edit pages through html forms, graphical preview, toolbar that helps you use the markup
* Edit pages through html forms, a graphical preview and a toolbar that helps you use mycomarkup
* Responsive design, dark theme (synced with system theme)
* Works in text browsers
* Everything is stored as simple files, no database required. You can run a wiki on almost any directory and get something to work with
@ -47,13 +47,13 @@ Options:
* History page
* Random page
* Recent changes page; RSS, Atom and JSON feeds available
* Hyphae can be deleted (while still preserving history)
* Hyphae can be deleted while still preserving history
* Hyphae can be renamed (recursive renaming of subhyphae is also supported)
* Light on resources
* Authorization with pre-set credentials, registration
* Basic Gemini protocol support
## Contributing
Help is always needed. We have a [tg chat](https://t.me/mycorrhizadev) where some development is coordinated. You can also sponsor on [boosty](https://boosty.to/bouncepaw). Feel free to open an issue or contact directly.
Help is always needed. We have a [tg chat](https://t.me/mycorrhizadev) where some development is coordinated. You can also sponsor bouncepaw on [boosty](https://boosty.to/bouncepaw). Feel free to open an issue or contact us directly.
You can view list of all planned features on [our kanban board](https://github.com/bouncepaw/mycorrhiza/projects/1).