rextendr icon indicating copy to clipboard operation
rextendr copied to clipboard

Unclear guidance: Please update the system requirement in DESCRIPTION file

Open malcolmbarrett opened this issue 4 years ago • 2 comments

use_extendr() requests: Please update the system requirement in DESCRIPTION file. I think this could be a bit clearer. Is there some generally useful boilerplate, e.g. what is in rextendr's DESCRIPTION (Rust 'cargo'; the crate 'libR-sys' must compile without error), that use_extendr() could offer?

In addition to offering clearer guidance here, we could suggest desc and modify it ourselves if installed, as usethis often does (desc is an implicit suggested pkg currently via devtools/usethis).

malcolmbarrett avatar Apr 16 '21 18:04 malcolmbarrett

I'm not even sure what exactly should be in the system requirements. That's maybe the first thing to figure out.

clauswilke avatar Apr 16 '21 19:04 clauswilke

Yes, that makes sense. There's probably a related issue here with guiding users on their toolchain setup when rextendr can't successfully run. Something like rust_sitrep(), similar to usethis::git_sitrep(), that reports what rextendr can find and make suggestions about troubleshooting

malcolmbarrett avatar Apr 17 '21 14:04 malcolmbarrett