Skip to content

Commit

Permalink
Reorganize README.md. (#16)
Browse files Browse the repository at this point in the history
The main instructions for using Eyra are now simple enough (just two
steps!) that it makes sense to have that be the "quick start", and to
move the link to the hello world example below that.
  • Loading branch information
sunfishcode authored Oct 26, 2023
1 parent f61725f commit 45c9973
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,6 @@ ABI-compatible libc function implementations.

## Quick start

Check out [this hello world example].

[this hello world example]: https://github.com/sunfishcode/eyra/tree/main/example-crates/hello-world/

## In detail

Eyra needs two things. First, a Cargo.toml dependency, which we can add with:

```console
Expand All @@ -50,6 +44,12 @@ Linux, this crate prints "Hello, world!". And under the covers, it uses
[Origin] to start and stop the program, [c-ward] to handle libc calls from
`std`, and [rustix] to do the printing, so it's completely implemented in Rust.

## Example

For an example of the above steps, check out [this hello world example].

[this hello world example]: https://github.com/sunfishcode/eyra/tree/main/example-crates/hello-world/

## Optional logging

Eyra has a `log` feature to enable Rust `log` tracing of program and thread
Expand Down

0 comments on commit 45c9973

Please sign in to comment.