]> Nishi Git Mirror - gwion.git/commitdiff
Create ContributingDocumentation.mdr
authorJérémie Astor <fennecdjay@gmail.com>
Wed, 16 Sep 2020 22:11:20 +0000 (00:11 +0200)
committerGitHub <noreply@github.com>
Wed, 16 Sep 2020 22:11:20 +0000 (00:11 +0200)
docs/Contributing/ContributingDocumentation.mdr [new file with mode: 0644]

diff --git a/docs/Contributing/ContributingDocumentation.mdr b/docs/Contributing/ContributingDocumentation.mdr
new file mode 100644 (file)
index 0000000..c85a7d9
--- /dev/null
@@ -0,0 +1,44 @@
+# Contributing Documentation
+
+> this is a stub for now, this place deserves better
+
+You might be here because you found something you could improve in [Gwion](https://github.com/fennecdjay/Gwion)'s documentation.
+Please open a [issue](https://github.com/fennecdjay/gwion-docs/issues) describing the problem and how you might address it.
+
+
+## Dependencies
+
+  * Gwion
+  * mdr
+  * MdBook
+  
+## Editing the documentation
+
+### Clone the source
+
+``` sh
+git clone https://github.com/fennecdjay/gwion-docs
+```
+
+### Edit some files
+
+``` sh
+cd gwion-docs
+make watch
+```
+
+### Add your changes
+
+``` sh
+git add docs/myfile.mdr
+```
+
+### Let the world know
+
+``` sh
+git commit -m "Something meaningful about why we are here"
+git push
+```
+
+You're now ready to submit a [PullRequest](https://github.com/fennecdjay/gwion-docs/pulls).
+