From 26c05217369b12e358732589248202250a1dac2d Mon Sep 17 00:00:00 2001
From: PlexSheep <PlexSheep@protonmail.com>
Date: Fri, 10 Feb 2023 22:03:34 +0100
Subject: [PATCH] README update

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..56c551c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# RustCommandLineCalcuator
+RustCommandLineCalcuator, or simply rclc for short is a fast, scriptable calculator that is 
+designed to run right in your shell. No more need to use the python shell, or ugly and bloated
+GUIs. Easily calculate complex formulas in your bash scripts.
+
+Currently, rclc's status is `indev`. This means that important major features are still missing
+and bugs might not only be possible but common.
+
+# Install
+Not yet recommended, but you can always compile rclc by yourself with `cargo build` and copy the
+compiled binary executable to `/usr/local/bin`.
+
+# Compatability
+| Supported OS | OS                    |
+|--------------|-----------------------|
+| Current      | Linux                 |
+| Planned      | Windows, OSX, FreeBSD |
+| Not Planned  | TempleOS              |
+
+| Supported Architectures | Arch   |
+|-------------------------|--------|
+| Current                 | x86_64 |
+| Planned                 | arm    |
+| Not Planned             | legacy |