Skip to content

Commit

Permalink
doc: update build instructions
Browse files Browse the repository at this point in the history
Update the build instructions to reflect the relocation of holo-cli
to its own repository (see #17). Additionally, remove outdated comment
from the Dockerfile.

Signed-off-by: Renato Westphal <renato@opensourcerouting.org>
  • Loading branch information
rwestphal committed Apr 15, 2024
1 parent 8ad0dd1 commit 9798566
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
7 changes: 5 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ Holo uses unstable Rust features, so building it from the source code requires a

If you don't already have Rust in your system, the best way to install it is via [rustup](https://rustup.rs/) (be sure to choose the nightly toolchain).

2. Clone Holo's git repository
2. Clone Holo's git repositories

```
$ git clone https://github.com/holo-routing/holo.git
$ git clone https://github.com/holo-routing/holo-cli.git
```

3. Install build dependencies:
Expand All @@ -28,6 +29,8 @@ You can install them using your system's package manager. For example, on Debian
```
$ cd holo/
$ cargo build --release
$ cd ../holo-cli/
$ cargo build --release
```

5. Add `holo` user and group:
Expand All @@ -39,7 +42,7 @@ $ cargo build --release

6. Installation

Copy the `holod` and `holo-cli` binaries from the `target/release` directory to your preferred location.
Copy the `holod` and `holo-cli` binaries from the `target/release` directories to your preferred location.

Alternatively, you can use `cargo install` to install these binaries into the `$HOME/.cargo/bin` directory.

Expand Down
2 changes: 1 addition & 1 deletion docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ WORKDIR /usr/src/holo
COPY . .
RUN cargo build --release

# holo-cli (order is important as holo-cli is using protobuf file in holo)
# holo-cli
# ==============================================================================

RUN git clone https://github.com/holo-routing/holo-cli.git /usr/src/holo-cli
Expand Down

0 comments on commit 9798566

Please sign in to comment.