Skip to content

Commit

Permalink
chore: apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Alexandre Sollier <github@kuruyia.net>
Signed-off-by: Mauran <thomas.mauran@etu.umontpellier.fr>
  • Loading branch information
thomas-mauran and Kuruyia committed May 2, 2024
1 parent 729c487 commit 7df2628
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,20 @@

## Prerequisites

Basic dependencies (with apt):
Install the dependencies. On Debian/Ubuntu:

```bash
apt install build-essential cmake pkg-config libssl-dev flex bison libelf-dev
```

Others:
Then, configure the Rust toolchain and install [Just](https://github.com/casey/just):

- add rust musl target: `rustup target add x86_64-unknown-linux-musl`
- add protoc binary: see [`github.com/protocolbuffers/protobuf`](https://github.com/protocolbuffers/protobuf)
- [just](https://github.com/casey/just): `cargo install just`
```bash
rustup target add x86_64-unknown-linux-musl
cargo install just
```

Finally, install [the protobuf compiler](https://github.com/protocolbuffers/protobuf?tab=readme-ov-file#protobuf-compiler-installation).

## Run Locally

Expand Down Expand Up @@ -65,15 +68,15 @@ release = true
EOF
```

Make sure to update the source-code-path to the path of the source code you want to run.
Make sure to update the `source-code-path` to the path of the source code you want to run.
Use an absolute path.

[Here](#config-file) are more informations about each field

### Start the VMM

> [!WARNING]
> Make sure to replace $CARGO_PATH with the path to your cargo binary
> Make sure to replace `CARGO_PATH` environment variable with the path to your cargo binary
>
> ```bash
> export CARGO_PATH=$(which cargo)
Expand All @@ -89,7 +92,7 @@ sudo -E capsh --keep=1 --user=$USER --inh=cap_net_admin --addamb=cap_net_admin -
cargo run --bin api
```

### Send the request using the cli
### Send the request using the CLI

```bash
cargo run --bin cli run --config-path src/agent/examples/config.toml
Expand Down Expand Up @@ -127,9 +130,6 @@ sequenceDiagram
5. The response is streamed back to the VMM and then to the API and finally to the CLI.

## Config file

table:

| Field | Description | Type |
| --- | --- | --- |
| workload-name | Name of the workload you wanna run | String |
Expand Down

0 comments on commit 7df2628

Please sign in to comment.