From 1a808055ea9426cf54005a754194a5b494be3b2d Mon Sep 17 00:00:00 2001 From: Djeeberjr Date: Tue, 1 Mar 2022 12:58:37 +0100 Subject: [PATCH] improved README --- REDME.md => README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) rename REDME.md => README.md (67%) diff --git a/REDME.md b/README.md similarity index 67% rename from REDME.md rename to README.md index 46891b2..40e60b6 100644 --- a/REDME.md +++ b/README.md @@ -6,7 +6,7 @@ General purpose "operation system" for [ComputerCraft](https://tweaked.cc/) buil - Rednet message routing - Hardware abstraction - Virtual screens to switch between multiple GUI apps -- Reactive UI framwork +- Reactive UI framework # Building @@ -18,6 +18,12 @@ Requirements: run `make deps && make`. The `bundle.min.lua` inside the `build` dir is the final file. +# Useful links + +[CC lua code](https://github.com/cc-tweaked/CC-Tweaked/tree/mc-1.16.x/src/main/resources/data/computercraft/lua) + +[CC wiki](https://tweaked.cc/) + # Development There are a couple of tool to your disposal that makes working easier. @@ -28,9 +34,9 @@ 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`. +You could use Minecraft to run the program 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. +Use `make webconsole` to run a http server that prints the log output of the program to the terminal. Run `haxe` with the `-D webconsole` flag. You may need to [allow connections](https://github.com/cc-tweaked/CC-Tweaked/wiki/Allowing-access-to-local-IPs) to any ip when using webconsole ingame.