From 82c4c7d2b66d28a74e9e1e1b34c87afa2c52c842 Mon Sep 17 00:00:00 2001
From: Aelita4 <mikorosa02@gmail.com>
Date: Tue, 19 Jan 2021 22:06:13 +0100
Subject: [PATCH] License & Readme

---
 LICENSE.md | 21 +++++++++++++++++++++
 README.md  | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 55 insertions(+)
 create mode 100644 LICENSE.md
 create mode 100644 README.md

diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..43eddc5
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Aelita4
+
+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.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..03d1f2f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# ONP
+
+Simple implementation of ONP algorithm in C++ (only works on Windows platform)
+## Installation
+
+Use g++ compiler from [GNU Compiler Collection](https://gcc.gnu.org/) package like this: 
+```bash
+g++ main.cpp -o onp.exe
+```
+
+## Usage
+
+You can provide additional arguments, like equation and speed of calculation
+
+If not providen any, program will ask for equation and set all speeds to default (100 ms)
+
+```bash
+onp.exe "2+2=" 100 100 100
+```
+
+### Notes:
+- Equation must be put in colons and end with equation mark (`=`)
+- Next three numbers represents wait times inside program (all in miliseconds), use larger number to slow down calculations and analyze how algorithm works
+  - first number is responsible for "checking" part of program
+  - second for converting equation to ONP format
+  - third for actual calculating
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)
\ No newline at end of file