docs and contributing files

This commit is contained in:
Felix Angell 2018-04-17 21:09:06 +01:00
parent 3a0938191f
commit 1e6fc83b89
2 changed files with 20 additions and 0 deletions

8
CONTRIBUTING.md Normal file
View File

@ -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.

12
DOCS.md Normal file
View File

@ -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