Make a pass over the README

Author: erlingrj

Makefile

@@ -1,6 +1,6 @@
-.PHONY: clean test coverage asan format format-check ci lf-test lib proto examples 
+.PHONY: clean test coverage asan format format-check ci lf-test lib proto
 
-test: unit-test lf-test examples
+test: unit-test lf-test
 
 # Generate protobuf code
 proto:
@@ -12,11 +12,6 @@ lib:
 	cmake --build build
 	make -C build
 
-# Build federated example
-examples:
-	cmake -Bbuild/posix/federated/ examples/posix/federated
-	make -C build/posix/federated/
-
 # Build and run the unit tests
 unit-test:
 	cmake -Bbuild -DBUILD_TESTS=ON

README.md

@@ -8,16 +8,17 @@ model-of-computation target at embedded and resource-constrained systems.
 NB: reactor-uc is still work-in-progress and sevearal reactor features are not supported
 yet. Moreover, the runtime has not been thoroughly tested so if you find any bugs or issues, please report them.
 
-Setup the environment
+
+Initialize submodules
 
 ```shell
-source env.bash
+git submodule update --init
 ```
 
-Initialize submodules
+Setup the environment
 
 ```shell
-git submodule update --init
+source env.bash # or env.zsh or env.fish 
 ```
 
 Compile and run unit tests:
@@ -31,19 +32,20 @@ make test
 ### Linux/POSIX
 
 ```shell
-make examples
-build/examples/posix/timer_ex
+cd examples/posix
+./buildAll.sh
+hello/build/app
 ```
 
 ### Zephyr
 Compile and run a simple test on Zephyr. This requires a correctly configured
 Zehyr environment, with West installed in a Python virtual environment which is
 activated. Inspect `.github/actions/zephyr/action.yml` for an example of how to setup your Zephyr workspace. 
 
-First a simple HelloWorld on the qemu_cortex_m3 target:
+First a simple HelloWorld on the `native_posix` target:
 ```shell
 cd examples/zephyr/hello
-west build -b qemu_cortex_m3 -p always -t run
+west build -b native_posix -p always -t run
 ```
 
 Then a simple blinky targeting NXP FRDM K64F. This will run with most boards supporting Zephyr that has a user LED.
@@ -52,8 +54,6 @@ cd examples/zephyr/blinky
 west build -b frdm_k64f -p always
 west flash
 ```
-For more information on running LF programs using the reactor-uc runtime on
-Zephyr take a look at this template: <https://github.com/lf-lang/lf-west-template/tree/reactor-uc>
 
 ### RIOT
 Compile and run a simple blinky example on RIOT.
@@ -76,39 +76,21 @@ make
 ```
 
 ### Lingua Franca
-NB: We are currently not keeping `lfc` up-to-date. We will probably do so again when the APIs have stabilized.
-
-We have copied a very limited version of the Lingua Franca Compiler (lfc) into
-`~/lfc` of this repo. In the future, the `reactor-uc` specific code-generation
-will be merged back upstream. By sourcing `env.bash` or `env.fish` the Lingua
-Franca Compiler will be aliased by `lfcg` for Lingua Franca Generator since this
-limited version mainly oes does code-generat
+Reactor-uc includes a limited version of the Lingua Franca Compiler (lfc) found in `~/lfc`. In the future, the
+`reactor-uc` specific code-generation will be merged back upstream. By sourcing `env.bash`, `env.fish` or `env.zsh` the
+Lingua Franca Compiler will be aliased by `lfcg`.
 
 ```shell
-cd examples/lf
-lfcg src/HelloUc.lf
+lfcg test/lf/src/HelloUc.lf
 ```
 
-Since a target platform is not specified, we will target POSIX in which case
-`lfc` will generate a main function and invoke CMake directly on the generated
-sources. Run the program with:
+Since the target platform is set to `Native`,`lfc` will generate a main function and invoke CMake directly on the
+generated sources. Run the program with:
 
 ```shell
-bin/HelloUc
+test/lf/bin/HelloUc
 ```
 
-## Goals
-
-- Incorporate unit testing and test-driven development from the start
-- Optimized for single-core 32-bit systems
-- Backend for LF
-- Standalone library
-- Use clang-format and clang-tidy to write safe code from the start.
-- CMake-based
-- Optimized for single-threaded runtime, but support for federated execution
-which enable distributed embedded systems.
-- Avoid malloc as much as possible (or entirely?)
-
 ## References
 
 `reactor-uc` draws inspiration from the following existing open-source projects:
@@ -134,4 +116,4 @@ CMake Error at CMakeLists.txt:7 (message):
   env.bash in reactor-uc.
 ```
 
-Please source `env.bash` or `env.fish`.
+Please source `env.bash`, `env.fish` or `env.zsh` to get the REACTOR_UC_PATH environment variable defined.

env.zsh

@@ -0,0 +1,7 @@
+#!/usr/bin/env zsh
+
+# Get the directory of the current script
+script_dir=$(dirname "$0:A")
+
+export REACTOR_UC_PATH=$script_dir
+alias lfcg='${REACTOR_UC_PATH}/lfc/bin/lfc-dev'

examples/common/timer_source.h

@@ -2,7 +2,7 @@
 
 DEFINE_TIMER_STRUCT(TimerSource, t, 1, 0);
 DEFINE_TIMER_CTOR(TimerSource, t, 1, 0);
-DEFINE_REACTION_STRUCT(TimerSource, r, 1);
+DEFINE_REACTION_STRUCT(TimerSource, r, 0);
 DEFINE_REACTION_CTOR(TimerSource, r, 0);
 
 typedef struct {

examples/posix/federated/CMakeLists.txt

@@ -6,7 +6,6 @@ set(NETWORK_CHANNEL_TCP_POSIX ON CACHE STRING "")
 add_subdirectory(../../../ reactor-uc)
 
 add_executable(sender sender.c)
-target_compile_definitions(sender PRIVATE "SCHEDULER_${SCHEDULER}")
 target_link_libraries(sender PRIVATE reactor-uc)
 
 add_executable(receiver receiver.c)

examples/riot/blinky/main.c

@@ -13,4 +13,5 @@ DEFINE_REACTION_BODY(TimerSource, r) {
 
 int main() {
   lf_start();
+  return 0;
 }

examples/zephyr/hello/src/hello.c

@@ -9,4 +9,5 @@ DEFINE_REACTION_BODY(TimerSource, r) {
 
 int main() {
   lf_start();
-}
+  exit(0);
+}