niklas/cc-haxe
1
0
Fork 0
Code Issues 13 Pull Requests Projects Releases Wiki Activity

improved README

Browse Source
This commit is contained in:
Djeeberjr 2022-03-01 12:58:37 +01:00
parent 2402eb1a44
commit 1a808055ea
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
REDME.md → README.md
View File

@ -6,7 +6,7 @@ General purpose "operation system" for [ComputerCraft](https://tweaked.cc/) buil
- Rednet message routing - Rednet message routing
- Hardware abstraction - Hardware abstraction
- Virtual screens to switch between multiple GUI apps - Virtual screens to switch between multiple GUI apps
- Reactive UI framwork - Reactive UI framework
# Building # Building
@ -18,6 +18,12 @@ Requirements:
run `make deps && make`. The `bundle.min.lua` inside the `build` dir is the final file. 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 # Development
There are a couple of tool to your disposal that makes working easier. 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 ## 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 ## 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. 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.