search

soenkehahn / cradle

Rust library for running child processes
Creative Commons Zero v1.0 Universal
38 stars 5 forks source link

Add design philosophy section to readme #188

Closed soenkehahn closed 3 years ago

soenkehahn commented 3 years ago

I was wondering whether to add this to the readme or to the main documentation (in lib.rs). Since the readme will be rendered into the crates' pages on crates.io, I think adding this to the readme is best.

soenkehahn commented 3 years ago

I see you snuck in a .php file!

Is that to make sure that the example in the readme compiles?

Yes.

If it isn't necessary to run it as a standalone example, then there might be other ways to accomplish this, for example by including the readme in a doc-comment, a.la. #[doc = include_str!("../README.md")]

If this were supported from the MSRV upwards, that sounds like it could be nice. Although the current solution works pretty well, and I don't see a super compelling reason to change it. :shrug: