Skip to content

Commit

Permalink
update doc to add protobuf installation guides (#583)
Browse files Browse the repository at this point in the history
Co-authored-by: zhangli20 <[email protected]>
  • Loading branch information
richox and zhangli20 authored Sep 23, 2024
1 parent 5b8939f commit 32fadb2
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,29 +54,36 @@ To build Blaze, please follow the steps below:
The native execution lib is written in Rust. So you're required to install Rust (nightly) first for
compilation. We recommend you to use [rustup](https://rustup.rs/).

2. Install JDK+Maven
2. Install Protobuf

Ensure `protoc` is available in PATH environment. protobuf can be installed via linux system package
manager (or Homebrew on mac), or manually download and build from https://github.com/protocolbuffers/protobuf/releases .

3. Install JDK+Maven

Blaze has been well tested on jdk8 and maven3.5, should work fine with higher versions.

3. Check out the source code.
4. Check out the source code.

```shell
git clone [email protected]:blaze-init/blaze.git
cd blaze
```

4. Build the project.
5. Build the project.

Specify shims package of which spark version that you would like to run on.

Currently we have supported these shims:

_Specify shims package of which spark version that you would like to run on._
_Currently we have supported these shims:
* spark303 - for spark3.0.x
* spark313 - for spark3.1.x
* spark324 - for spark3.2.x
* spark333 - for spark3.3.x
* spark351 - for spark3.5.x.

_You could either build Blaze in dev mode for debugging or in release mode to unlock the full potential of
Blaze._
You could either build Blaze in pre mode for debugging or in release mode to unlock the full potential of
Blaze.

```shell
SHIM=spark333 # or spark303/spark313/spark320/spark324/spark333/spark351
Expand All @@ -89,7 +96,7 @@ directory.

## Build with docker

_You can use the following command to build a centos-7 compatible release:_
You can use the following command to build a centos-7 compatible release:
```shell
SHIM=spark333 MODE=release ./release-docker.sh
```
Expand Down

0 comments on commit 32fadb2

Please sign in to comment.