roots/wiki
1
0
Fork 0
mirror of https://github.com/PhyllomeOS/wiki.git synced 2024-11-05 19:51:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Create README.md

Browse Source 
Create README.md with instructions on how to contribute. Workflow still has to be tested out.
This commit is contained in:
Lukas 2021-11-13 23:27:48 +01:00 committed by GitHub
parent 74b8d9a4cd
commit dc4ef10550
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md Normal file
View File

@ -0,0 +1,33 @@
# 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.