Skip to content

Commit

Permalink
Minor documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
haixuanTao committed Dec 21, 2022
1 parent 15e42c1 commit cf16734
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 16 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Dataflow Oriented Robotic Architecture ⚡

This project is in early development, and many features have yet to be implemented with breaking changes. Please don't take for granted the current design.

`dora` primary support is with `Linux` ( Ubuntu 20.04 and Ubuntu 22.04 ) as it is the primary OS for both Cloud and small computers. If you wish to use `dora` with another OS, please compile from source.
`dora` primary support is with `Linux` as it is the primary OS for both Cloud and small computers. If you wish to use `dora` with another OS, please compile from source.

---
## 📖 Documentation
Expand Down Expand Up @@ -101,7 +101,7 @@ communication:
nodes:
- id: op_1
operator:
python: https://raw.githubusercontent.com/dora-rs/dora-drives/main/operators/webcam.py
python: https://raw.githubusercontent.com/dora-rs/dora-drives/main/operators/webcam_op.py
inputs:
tick: dora/timer/millis/100
outputs:
Expand Down
31 changes: 17 additions & 14 deletions docs/src/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,31 @@

This project is in early development, and many features have yet to be implemented with breaking changes. Please don't take for granted the current design. The installation process will be streamlined in the future.

### 1. Compile the dora-coordinator
### Download the binaries from Github

The `dora-coordinator` is responsible for reading the dataflow descriptor file and launching the operators accordingly.

Build it using:
Install `dora` binaries from GitHub releases:

```bash
git clone https://github.com/dora-rs/dora.git
cd dora
cargo build -p dora-coordinator --release
wget https://github.com/dora-rs/dora/releases/download/<version>/dora-<version>-x86_64-Linux.zip
unzip dora-<version>-x86_64-Linux.zip
python3 -m pip install dora-rs==<version> ## For Python API
PATH=$PATH:$(pwd):$(pwd)/iceoryx
dora --help
```

### 2. Compile the dora-runtime for operators
#### Or compile from Source

The `dora-runtime` is responsible for managing a set of operators.
Build it using:
```bash
cargo build -p dora-runtime --release
git clone https://github.com/dora-rs/dora.git
cd dora
cargo build -p dora-coordinator -p dora-runtime --release
PATH=$PATH:$(pwd)/target/release
```

### 3. Add those binaries to your path

This step is optional. You can also refer to the executables using their full path or copy them somewhere else.

If you want to use `Iceoryx`. Add `iox-roudi` to the path.
You can find `iox-roudi` with:
```bash
export PATH=$PATH:$(pwd)/target/release
find target -type f -wholename "*/iceoryx-install/bin/iox-roudi"
```

0 comments on commit cf16734

Please sign in to comment.