Skip to content

fix: explain missing Brotli submodule during build #1

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.

Sign up for GitHub

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

Open
manuelsampedro1 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: explain missing Brotli submodule during build #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ Brotlic (or BrotliC) is a thin wrapper around [brotli](https://github.com/google

A __C__ compiler is required for building [brotli](https://github.com/google/brotli) with cargo.

When building from a git checkout, initialize the bundled Brotli C submodule first:

```sh
git submodule update --init --recursive
```

## Usage

Brotlic provides Rust bindings to all compression and decompression APIs. On the fly compression and
Expand Down
8 changes: 8 additions & 0 deletions brotlic-sys/build.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ use std::path::PathBuf;
fn main() {
let manifest_dir = PathBuf::from(env::var_os("CARGO_MANIFEST_DIR").unwrap());
let include_dir = manifest_dir.join("brotli/c/include");
let required_source = manifest_dir.join("brotli/c/common/constants.c");

if !required_source.exists() {
panic!(
"missing Brotli C sources at {}. If building from a git checkout, run `git submodule update --init --recursive` first.",
required_source.display()
);
}

cc::Build::new()
.files(&[
Expand Down