diff --git a/LICENSE.md b/LICENSE.txt similarity index 100% rename from LICENSE.md rename to LICENSE.txt diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..580f16d --- /dev/null +++ b/README.adoc @@ -0,0 +1,27 @@ += STE (Simple Terminal Editor) +Doc Writer +v0.1, 2019-11-23 + +ste is a simple terminal editor partly inspired by micro +and GNU-nano + +.Features include +* Simple commands (ctrl-s to save) +* Light on resources +* Great for learning + +The main focus is to make a good terminal text and code +editor without all the mode nonsense, providing just +enough to the end user to be useful but not too much. +Of course this is an open source project and as for myself +I take it as a learning ground, basically try not to set +your expectations too high. + +As for contributing goes feel free to add features, best +if in your own fork and then submint a merge request, the +only caveat is __comment your code__, not just for good +but because, as I said, I mainly view this project as a +learning gorund that can be useful to many others joining +in the adventure of writing one of the most basic, yet +most complex, tool. + +Last but not least: have fun. diff --git a/README.md b/README.md deleted file mode 100644 index 10373aa..0000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# ste simple terminal editor -ste is a simple terminal editor partly inspired by micro features include -* simple commands (ctrl-s to save) -* light on resources -* easy to lookaround the code - - -basically how you'd want nano to be if it actually had sane defauts \ No newline at end of file