Skip to content

Commit 8faa5ba

Browse files
committed
Update toolchain documentation, also add diagrams.net drawing to repo
1 parent 1f37d17 commit 8faa5ba

File tree

3 files changed

+163
-3
lines changed

3 files changed

+163
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,29 @@ This git repository provides the source codes for the **WebPBrick** project and
55

66
## WebPBrick How To
77

8-
1. Build your NQC code (click the "Build" button)
9-
2. Connect to the yellow programmable RCX brick using an infrared tower (click the "Serial Connect" button)
10-
3. Download your compiled program to the RCX (click the "Download program to RCX" button)
8+
1. Write NQC code _(or use BlockNQC to generate the code)_
9+
2. Build your NQC code (click the "Build" button)
10+
3. Connect to the yellow programmable RCX brick using an infrared tower (click the "Serial Connect" button)
11+
4. Download your compiled program to the RCX (click the "Download program to RCX" button)
1112

13+
## WebPBrick's BlockNQC
14+
15+
A web-based visual programming editor called BlockNQC can be used to generate NQC code. BlockNQC is based on Google's Blockly. For details, see BlockNQC's separate [README](./nqc/blocknqc/README.md) file.
1216

1317
## Toolchain modules
1418

1519
![Toolchain block diagram](./doc/toolchain.png)
1620

1721
WebPBrick's toolchain consists of several modules:
1822

23+
* BlockNQC: Web-based visual programming editor called BlockNQC that can be used to generate NQC code (based on Google's Blockly).
1924
* WebNQC: The NQC compiler built as WebAssembly (WASM) for the web using emscripten.
2025
* RCX image parser written in Kaitai Struct and compiled to JavaScript to parse and split RCX image binary files so that they can be downloaded to the RCX in their bytecode chunks.
2126
* RCX communication libraries:
2227
* Based on Web Serial API to be used with the LEGO IR Serial Tower and [DIY IR serial towers](https://github.com/maehw/DiyIrTower)
2328
* Based on WebUSB API to be used with LEGO IR USB Tower
2429

30+
Those modules could be used independently.
2531

2632
## Run
2733

0 commit comments

Comments
 (0)