added README

Makefile

@@ -1,7 +1,7 @@
 BUNDLE_NAME = bundle.lua
 HAXE_NAME = haxe.lua
-MINIFYD_NAME := bundle.min.lua
+MINIFYD_NAME = bundle.min.lua
-BUILD_DIR := build
+BUILD_DIR = build
 HAXE_FLAGS = -D webconsole
 POLYFILLED_NAME = bundle.polyfill.lua
 POLYFILL_SRC = src/polyfill.lua
@@ -10,7 +10,7 @@ HAXE_PATH := $(BUILD_DIR)/$(HAXE_NAME)
 MIN_PATH := $(BUILD_DIR)/$(MINIFYD_NAME)
 POLYFILL_PATH := $(BUILD_DIR)/$(POLYFILLED_NAME)
 
-all: clean $(MIN_PATH)
+all: clean build
 
 build: $(MIN_PATH)
 
@@ -32,7 +32,7 @@ clean:
 watch:
 	find src -name "*.hx" | entr make build
 
-debug:
+emulator:
 	craftos --mount-ro /=build 
 
 webconsole:

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. 
+