Browse Source

Apply README suggestions from code review

Co-authored-by: Xavier Tao <tao.xavier@outlook.com>
tags/v0.0.0-test.4
Philipp Oppermann GitHub 3 years ago
parent
commit
7fd1916b32
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 10 deletions
  1. +12
    -7
      coordinator/README.md
  2. +5
    -3
      runtime/examples/c-operator/README.md

+ 12
- 7
coordinator/README.md View File

@@ -27,14 +27,19 @@ There are drawbacks too, for example:

## Try it out

- Compile the dora runtime using `cargo build -p dora-runtime --release`
- Compile the nodes in `examples` using `cargo build -p dora-coordinator --examples --release`
- Compile the Rust example operator through `cargo build --manifest-path ../runtime/examples/example-operator/Cargo.toml --release`
- Compile: the dora runtime, the nodes in `examples`, and the Rust example operator through:
```bash
cargo build -p dora-runtime --release
cargo build -p dora-coordinator --examples --release
cargo build --manifest-path ../runtime/examples/example-operator/Cargo.toml --release
```
- Compile the C example operator through:
- `cd ../runtime/examples/c-operator`
- `cp ../../../api/c/operator/api.h .`
- `clang -c operator.c`
- `clang -shared -v operator.o -o operator.so`
```bash
cd ../runtime/examples/c-operator
cp ../../../api/c/operator/api.h .
clang -c operator.c
clang -shared -v operator.o -o operator.so
```
- Run the `mini-dataflow` example using `cargo run --release -- run examples/mini-dataflow.yml`
- This spawns a `timer` source, which sends the current time periodically, and a `logger` sink, which prints the incoming data.
- The `timer` will exit after 100 iterations. The other nodes/operators will then exit as well because all sources closed.


+ 5
- 3
runtime/examples/c-operator/README.md View File

@@ -2,6 +2,8 @@

Build with these steps:

- `cp ../../../api/c/operator/api.h .`
- `clang -c operator.c`
- `clang -shared -v operator.o -o operator.so`
```bash
cp ../../../api/c/operator/api.h .
clang -c operator.c
clang -shared -v operator.o -o operator.so
```

Loading…
Cancel
Save