wiki/README.md

34 lines
1.1 KiB
Markdown
Raw Normal View History

# The Phyllome OS wiki
This repository contains the articles that together make up the [**Phyllome OS wiki**](https://wiki.phyllo.me).
A two-ways sync is setup between this repository and the wiki solution, based on [wiki.js](https://js.wiki/). Contributions through the wiki web interface are currently only open to [core contributors](https://wiki.phyllo.me/project/join).
## How to contribute
> **Attention please**: Do *not* create new files, as they are not taken into account by `wiki.js`. Please create an issue if you wish to create new pages.
* Clone the repository:
```
git clone https://github.com/PhyllomeOS/wiki/
```
* Add or modify some contents to an *existing page* using your favorite text editor.
> Please follow the [CommonMark Spec syntax](https://spec.commonmark.org/). Have a look [here](https://docs.requarks.io/editors/markdown) to see what can be done and how.
* Create a pull request when you are done, sit back, and relax.
Thank you!
## Licence
Contributions are made under a [CC BY 4.0 Licence](https://creativecommons.org/licenses/by/4.0/), for the Phyllome OS Project.