add readme and license

Author: nedpals

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 The ErrgoEngine Authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,25 @@
+> [!IMPORTANT]
+> What you are seeing here is an in-progress implementation of our thesis paper. This is not usable as of the moment and it remains unanswered if this is effective while no testing has been conducted yet as of the moment.
+
+# ErrgoEngine
+A contextualized programming error analysis translation engine.
+
+It is a Go package that analyzes the programming error message in order to build a contextualized data which contains the error type, the data extracted from the error message text and the files from the extracted stack trace data. The data is then used to generate an enhanced form of programming error message which contains an explanation and bug fix suggestions which is local to the said error and at the same time the program's codebase.
+
+Our aim here is to be able to assist novice programmers in enhancing their debugging skills by providing more information that will help them fully understand the programming errors presented to them.
+
+## Programming languages supported
+ErrgoEngine uses the [tree-sitter](https://github.com/tree-sitter/tree-sitter) parser to extract information from the source code from different programming languages in a unified way. This enables us to support a variety of programming languages as long as there is support for it. At the moment, we only support for **Java** and **Python** but we will be able to support more programming languages, and in return more types of programming errors, in the near future with improved interface for langauge support.
+
+## Dependencies
+ErrgoEngine only relies on the third-party [go-tree-sitter](https://github.com/smacker/go-tree-sitter) package for parsing but the rest of the code relies on the Go standard library so it should not be a problem at all when importing this package to your application.
+
+## TODO
+- [ ] Implementation of error templates
+- [ ] Tests
+
+## Paper
+- TODO
+
+## Copyright and license
+(c) 2023 by the [ErrgoEngine Authors](https://github.com/nedpals/errgoengine/graphs/contributors). Code released under the [MIT License](https://github.com/nedpals/errgoengine/blob/main/LICENSE).