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

added build doc

Browse Source
This commit is contained in:
Niklas Kapelle 2024-08-05 13:59:23 +02:00
parent 29285641a4
commit 7d30d9d971
Signed by: niklas
GPG Key ID: 4EB651B36D841D16
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/Concepts.md
View File

@ -57,7 +57,7 @@ Also peripherals can be made accessible via the network. More on that later.
var back = Peripheral.getRedstone("back"); var back = Peripheral.getRedstone("back");
back.setOutput(true); back.setOutput(true);
var drive Peripheral.getDrive("drive_0"); var drive = Peripheral.getDrive("drive_0");
drive.eject(); drive.eject();
``` ```
@ -114,7 +114,7 @@ The idea is that you can register all you disposable resources in the handle and
A process can be used as a command on the terminal or as a service. See [bin/HelloWorld.hx](../src/bin/HelloWorld.hx) for an example. A process can be used as a command on the terminal or as a service. See [bin/HelloWorld.hx](../src/bin/HelloWorld.hx) for an example.
Basically everything that runs and is not part of the kernel is a process. Basically everything that runs and is not part of the kernel is a process.
In order for you program to be used it needs to be registered in the `BinStore` and the `DCEHack` manually. ~~In order for you program to be used it needs to be registered in the `BinStore` and the `DCEHack` manually. ~~
# EndOfLoop # EndOfLoop
@ -208,3 +208,19 @@ rpc.addNumber(3,7).handle((p)->{
} }
}); });
``` ```
# Build system and flags
We use `make` to build the project. If you want a prod build just run `make` and if you want the debug build run `make debug`.
The `build` directory should contain all needed files.
- `bundle.min.lua`: The minified final file
- `bundle.polyfill.lua`: The same as above just not minified. use this when debugging.
- `haxe.lua`: Intermediate file. Polyfill not yet added.
- `haxe.zip`: The compressed `bundle.min.lua`.
- `unpack.*`: Same as the bundle files. Used to unpack and run the `haxe.zip` file.
The follwing haxe flags can be used in the code or can be set in the makefile.
- `debug`: Is set when debug
- `kv_use_native`: If set use the native CC serialize and unserialize functions instead of the Haxe ones. See [KVStore.hx](../src/lib/KVStore.hx) for more.