Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor documentation tidying. #5

Merged
merged 2 commits into from
Sep 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion c-scape/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ Similar to c-gull, c-scape has "take-charge" and "coexist-with-libc" modes.
"take-charge" mode requires some additional setup; see the [c-scape-example]
example crate for more details.

[c-gull]: https://crates.io/crates/c-gull
[c-gull]: https://github.com/sunfishcode/c-ward/tree/main/c-gull
[c-scape-example]: https://github.com/sunfishcode/c-ward/blob/main/example-crates/c-scape-example
7 changes: 5 additions & 2 deletions example-crates/eyra-example/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
This crate demonstrates the use of eyra.
This crate demonstrates the use of Eyra.

This version uses `extern crate libc;` to ensure that eyra is linked in.
See the [detiled walkthrough] for a list of how this hello world
example crate works.

[detiled walkthrough]: https://github.com/sunfishcode/c-ward/tree/main/eyra#in-detail
11 changes: 9 additions & 2 deletions example-crates/eyra-libc-example/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
This crate demonstrates the use of eyra.
This crate demonstrates the use of Eyra.

This version uses a reference to `libc` to ensure that eyra is linked in.
This is similar to [eyra-example], but additionally demonstrates the
use of `libc` APIs by saying "Hello, world!" using the libc `printf`
interface.

The `printf` implementation is provided by [c-gull].

[eyra-example]: https://github.com/sunfishcode/c-ward/tree/main/example-crates/eyra-example/
[c-gull]: https://github.com/sunfishcode/c-ward/tree/main/c-gull
18 changes: 9 additions & 9 deletions eyra/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<h1><code>eyra</code></h1>
<h1><code>Eyra</code></h1>

<p>
<strong>Rust programs written entirely in Rust</strong>
Expand All @@ -13,7 +13,7 @@
</p>
</div>

eyra is a package that supports building Rust programs implemented entirely
Eyra is a package that supports building Rust programs implemented entirely
in Rust.

## Quick start
Expand Down Expand Up @@ -46,11 +46,11 @@ fn main() {
}
```

This tells Rust that eyra is actually used and the libraries should
actually be linked in.
This tells Rust that Eyra is actually used and the libraries should actually
be linked in.

And finally, a build.rs file to add `-nostartfiles` to the link flags to
disable the host startup code, so that eyra can provide its own. build.rs:
disable the host startup code, so that Eyra can provide its own. build.rs:

```rust
fn main() {
Expand All @@ -65,15 +65,15 @@ implemented in Rust.

## Background

This is similar to [mustang] and uses the same underlying code, but instead
of using a custom target and -Z build-std, it just by needs users to add
Eyra is similar to [Mustang] and uses the same underlying code, but instead
of using a custom target and -Z build-std, Eyra just needs users to add
`-nostartfiles` to their link line, such as via build.rs in the example.

Like mustang, eyra currently runs on Rust Nightly on Linux on x86-64, x86,
Like Mustang, Eyra currently runs on Rust Nightly on Linux on x86-64, x86,
aarch64, and riscv64. It aims to support all Linux versions [supported by Rust],
though at this time it's only tested on relatively recent versions.

[mustang]: https://github.com/sunfishcode/mustang
[Mustang]: https://github.com/sunfishcode/mustang
[origin]: https://github.com/sunfishcode/origin
[c-ward]: https://github.com/sunfishcode/c-ward
[rustix]: https://github.com/sunfishcode/rustix
Expand Down