Skip to content

Update README, specifically Windows section #31

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

Closed
Ilia-Kosenkov opened this issue Dec 18, 2020 · 5 comments · Fixed by #69
Closed

Update README, specifically Windows section #31

Ilia-Kosenkov opened this issue Dec 18, 2020 · 5 comments · Fixed by #69

Comments

@Ilia-Kosenkov
Copy link
Member

The Windows section is particularly outdated providing recent developments in how we build on Windows.
(see #9 and #29).

I suggest to also include powershell commands as it is the new standard, plus default shell is cumbersome and sometimes difficult to navigate.
I tried to summarise Windows-related updates in libR-sys/readme-windows.
This can be merged as PR if it seems reasonable.

Also, README lacks description of feature flags and how to build bindgen vs pre-compiled versions.

@clauswilke
Copy link
Member

Yes, please prepare a PR. Thanks!

@Ilia-Kosenkov
Copy link
Member Author

Ilia-Kosenkov commented Dec 19, 2020

PR #32 updated README, mostly Windows-specific part. Now a few more lines should be added to describe how to generate bindings on MacOS/Linux.

@clauswilke
Copy link
Member

In particular, I just noticed that we never explicitly state how to build bindings from source:

cargo build --features use-bindgen

@Ilia-Kosenkov
Copy link
Member Author

@clauswilke, I put that into Windows description, simple version suggests to use precomputed bindings, advanced -- to build your own using --features use-bindgen. As I did not touch other OS' sections, there is no mention of that, unfortuantely.

@Ilia-Kosenkov
Copy link
Member Author

After discussion in extendr/rextendr#19, we need to revise the README, Windows section.
Right now the instructions are incorrect, at least for pre-computed bindings.
If we decided to use a single toolchain, stable-msvc, then to build for gnu targets we need linkers, which come from msys2.
So msys2 with mingw toolchains are required in any case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants