Skip to content

Commit

Permalink
docs(readme): remove contributing guidelines
Browse files Browse the repository at this point in the history
... this will be moved to the wiki for now.
  • Loading branch information
n0toose authored and jounathaen committed Dec 13, 2024
1 parent 1acede8 commit 22ff6c4
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 36 deletions.
33 changes: 0 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,36 +140,3 @@ at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

---

## Contributing

### Testing Hermit apps using `cargo run`

As mentioned above, the Uhyve repository ships some binaries that can be used for testing purposes.

```sh
cargo run -- data/x86_64/rusty_demo
cargo run -- data/x86_64/hello_world
cargo run -- data/x86_64/hello_c
```

### Debugging Hermit apps

Basic support of (single-core) applications is already integrated into Uhyve.

By specifying variable `HERMIT_GDB_PORT=port`, Uhyve is working as gdbserver and is waiting on port `port` for a connection to a gdb.
For instance, with the following command Uhyve is waiting on port `6677` for a connection.

```bash
HERMIT_GDB_PORT=6677 uhyve /path_to_the_unikernel/hello_world
```

In principle, every gdb-capable IDE should be able to debug Hermit applications. (Eclipse, VSCode, ...)

#### Visual Studio Code / VSCodium

The repository [hermit-rs](https://github.com/hermit-os/hermit-rs) provides [example configuration files](https://github.com/hermit-os/hermit-rs/tree/master/.vscode) to debug a Hermit application with [Visual Studio Code](https://code.visualstudio.com/), [VSCodium](https://vscodium.com/) or derivatives of [Eclipse Theia](https://theia-ide.org/).

![Debugging Hermit apps](img/vs_code.png)

3 changes: 0 additions & 3 deletions img/vs_code.png

This file was deleted.

0 comments on commit 22ff6c4

Please sign in to comment.