README.md

BEE

A web browser engine to be embedded within applications

What's BEE?

BEE is a web browser engine intended to be embedded within applications.

Development

Install the following software:

• Rust
• GNU Bash
• GNU Make
• CMake
• Ninja
• Deno
• Nextest
• jq
• yq
• Docker CLI

Then:

# Run once before building.
# Run again if some of third-party packages have been updated.
make vendor

# Run once before building.
# Run again if some of input files of generated source files have been updated.
make codegen

# Run tests.
make test

# Make docs.
make doc

# release build.
make build OPTIONS='-r'

# List targets defined in the top-level Makefile.
make list-targets

Worked only on Linux and macOS at this point. Windows will be supported in the future.

In addition, it's recommended to install the following software:

• cargo-llvm-cov
• flamegraph
• hyperfine
• mold
• perf

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.