Skip to content

Commit 3c76d44

Browse files
authored
Shorten compiler instructions/brotlipy error info for Windows users (#1006)
1 parent 3268ca6 commit 3c76d44

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,8 @@ with security issues that have been compiled into their binaries.
118118
## Requirements
119119

120120
To use the auto-extractor, you may need the following utilities depending on the
121-
type of file you need to extract. Belows are required to run the full
122-
test suite on linux:
121+
type of file you need to extract. The utilities below are required to run the full
122+
test suite on Linux:
123123

124124
- `file`
125125
- `strings`
@@ -143,18 +143,14 @@ Windows has `ar` and `Expand` installed in default, but `7z` in particular might
143143
If you want to run our test-suite or scan a zstd compressed file, We recommend installing this [7-zip-zstd](https://github.com/mcmilk/7-Zip-zstd)
144144
fork of 7zip. We are currently using `7z` for extracting `jar`, `apk`, `msi`, `exe` and `rpm` files.
145145

146-
If you get an error from pip about building the wheel like this
147-
"building 'libbrotli' library
148146

149-
error:Microsoft Visual C++ 14.0 or greater is required. Get it with "Microsoft C++ Build Tools": https://visualstudio.microsoft.com/visual-cpp-build-tools/
147+
If you get an error about building libraries when you try to install from pip,
148+
you may need to install the Windows build tools. The Windows build tools are
149+
available for free from
150+
https://visualstudio.microsoft.com/visual-cpp-build-tools/
150151

151-
-----------------------------------------
152-
ERROR: Failed building wheel for brotlipy"
153-
154-
This indicate,you may need to install the windows compiler tools from $url so pip can compile all needed components
155-
If you follow the link it gives you https://visualstudio.microsoft.com/visual-cpp-build-tools/ you should be able to download the compiler for free.
156-
Basically, the python "wheel" here in the package for brotlipy contains a c library and they haven't provided a pre-compiled one for your specific platform, so pip is trying to do that for you so the library will work, but it wasn't able to because it couldn't find the appropriate compiler.
157-
If you already have a C/C++ compiler, you can probably tell pip to use that one, but since the microsoft compiler is free and available at the link, that's probably the easiest way to solve the error.
152+
If you get an error while installing brotlipy on Windows, installing the
153+
compiler above should fix it.
158154

159155
## Feedback & Contributions
160156

0 commit comments

Comments
 (0)