docs and contributing files

felixangell · Apr 17, 2018 · 1e6fc83 · 1e6fc83
1 parent 3a09381
commit 1e6fc83
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,8 @@
+# Contributing
+This is a little guide to help you contribute to the editor. Check the README for
+build/install instructions.
+
+## Creating Issues
+Reporting bugs alone is a great help. If you catch anything please report it
+into the issue tracker. It's appreciated if you check that you are not reporting
+a bug that has been reported before.
diff --git a/DOCS.md b/DOCS.md
@@ -0,0 +1,12 @@
+# Documentation
+This file is documentation for the editor itself. It covers:
+
+* a list of commands availible;
+* configuration options; and
+* adding new syntax configurations to the editor;
+
+Contributions to this are welcome. Note: due to the volatility
+of the editor, this documentation will be outdated, have mistakes,
+spelling errors, and more.
+
+## Index