From 1d2d4d88f88afb5f41d769d3813c307df20a6752 Mon Sep 17 00:00:00 2001
From: Djeeberjr <djeeberjr@gmail.com>
Date: Mon, 21 Feb 2022 02:44:45 +0100
Subject: [PATCH] added README

---
 REDME.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 REDME.md

diff --git a/REDME.md b/REDME.md
new file mode 100644
index 0000000..f2adf3b
--- /dev/null
+++ b/REDME.md
@@ -0,0 +1,36 @@
+General purpose "operation system" for [ComputerCraft](https://tweaked.cc/) build with [Haxe](https://haxe.org/). 
+
+# Features
+
+- TCP like rednet messages
+- Rednet message routing
+- Hardware abstraction
+- Virtual screens to switch between multiple GUI apps
+- Reactive UI framwork
+
+# Building
+
+Requirements: 
+- `haxe` compiler
+- `haxelib` for dependencies
+- `nodejs` and package manager like `yarn`
+- `make`
+
+run `make deps && make`. The `bundle.min.lua` inside the `build` dir is the final file.
+
+# Development
+
+There are a couple of tool to your disposal that makes working easier. 
+
+## Watch 
+
+Run `make watch` to recompile when a file changed.
+
+## Emulator
+
+You could use minecraft to run the programm or you could use [craftos pc](https://www.craftos-pc.cc/) as an emulator. Just install it and run `make emulator`. 
+
+## Websconsole
+
+Use `make webconsole` to run a http server that prints the log output of the programm to the terminal. Run `haxe` with the `-D webconsole` flag. 
+