From 7fd1916b32d4f6d3cfd288f27388cae0a5fd08fd Mon Sep 17 00:00:00 2001
From: Philipp Oppermann <dev@phil-opp.com>
Date: Wed, 22 Jun 2022 13:07:06 +0200
Subject: [PATCH] Apply README suggestions from code review

Co-authored-by: Xavier Tao <tao.xavier@outlook.com>
---
 coordinator/README.md                 | 19 ++++++++++++-------
 runtime/examples/c-operator/README.md |  8 +++++---
 2 files changed, 17 insertions(+), 10 deletions(-)

diff --git a/coordinator/README.md b/coordinator/README.md
index ae99035f..90a3e6c4 100644
--- a/coordinator/README.md
+++ b/coordinator/README.md
@@ -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.
diff --git a/runtime/examples/c-operator/README.md b/runtime/examples/c-operator/README.md
index f246c0c7..6dfe5e0a 100644
--- a/runtime/examples/c-operator/README.md
+++ b/runtime/examples/c-operator/README.md
@@ -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
+```