Skip to content

Update docs #69

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.

Sign up for GitHub

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

Merged
nicholasbishop merged 1 commit into from
Aug 22, 2026
Merged

Update docs #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 1 addition & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@

`printf` reimplemented in Rust

This is a complete reimplementation of `printf` in Rust. It requires the
`c_variadic` feature, which will be stable in Rust 1.99, but currently
requires the nightly toolchain.
This is a complete reimplementation of `printf` in Rust. Example use cases:

- [Many C][sigrok-log] [libraries][libusb-log] provide a way to provide a
custom log callback. With this crate, you can provide a pure Rust option,
Expand All @@ -20,10 +18,6 @@ requires the nightly toolchain.
formatting code, or use a minimal formatting library like [`ufmt`] or
[`defmt`]. Don't need *every* single option given by `printf` format
strings? No problem! Just don't implement it.
- Likewise, if you're using `wasm32-unknown-unknown` instead of emscripten
(as wasm-bindgen is only compatible with the former), you have no libc. If
you want to interface with a C library, you'll have to do it all yourself.
With this crate, that turns into 5 lines instead of hundreds for `printf`.

## Benefits

Expand Down
8 changes: 1 addition & 7 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
//! `printf` reimplemented in Rust
//!
//! This is a complete reimplementation of `printf` in Rust. It requires the
//! `c_variadic` feature, which will be stable in Rust 1.99, but currently
//! requires the nightly toolchain.
//! This is a complete reimplementation of `printf` in Rust. Example use cases:
//!
//! - [Many C][sigrok-log] [libraries][libusb-log] provide a way to provide a
//! custom log callback. With this crate, you can provide a pure Rust option,
Expand All @@ -15,10 +13,6 @@
//! formatting code, or use a minimal formatting library like [`ufmt`] or
//! [`defmt`]. Don't need *every* single option given by `printf` format
//! strings? No problem! Just don't implement it.
//! - Likewise, if you're using `wasm32-unknown-unknown` instead of emscripten
//! (as wasm-bindgen is only compatible with the former), you have no libc. If
//! you want to interface with a C library, you'll have to do it all yourself.
//! With this crate, that turns into 5 lines instead of hundreds for `printf`.
//!
//! # Benefits
//!
Expand Down