Skip to content

Commit 04ee38c

Browse files
committed
Add notes on how to deal with build failures on fedora, and other platforms (GitoxideLabs#592)
1 parent 299dc00 commit 04ee38c

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,9 +182,6 @@ Our [stability guide] helps to judge how much churn can be expected when dependi
182182

183183
## Installation
184184

185-
Note that on Fedora, perl needs to be installed for OpenSSL to build properly. This can be done with the following command:
186-
`dnf install perl`
187-
188185
### Download a Binary Release
189186

190187
Using `cargo quickinstall`, one is able to fetch [binary releases][releases]. You can install it via `cargo install cargo-quickinstall`, assuming
@@ -220,6 +217,16 @@ The following installs the latest unpublished release directly from git:
220217
cargo install --git https://github.com/Byron/gitoxide gitoxide
221218
```
222219

220+
#### How to deal with build failures
221+
222+
On some platforms, installation may fail due to lack of tools required by `C` toolchains. This can generally be avoided by installation
223+
with `cargo install gitoxide --no-default-features --features small`.
224+
225+
What follows is a list of known failures.
226+
227+
- On Fedora, `perl` needs to be installed for `OpenSSL` to build properly. This can be done with the following command:
228+
`dnf install perl` (see [this issue](https://github.com/Byron/gitoxide/issues/592)).
229+
223230
[releases]: https://github.com/Byron/gitoxide/releases
224231
[rustup]: https://rustup.rs
225232

0 commit comments

Comments
 (0)