Skip to content

Commit

Permalink
Update README to use bazelisk and add ".bazelversion" for PipelienDP4j
Browse files Browse the repository at this point in the history
Change-Id: I555f2cf1e4c93f060c52d0f20824b6857c860b26
GitOrigin-RevId: d3bcbb98f461ec05630777287830626856a1e11d
  • Loading branch information
Differential Privacy Team authored and RamSaw committed Oct 30, 2024
1 parent 4caf604 commit 0a80e37
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 11 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,51 +60,52 @@ experimental and subject to change.

## How to Build

In order to run the differential privacy library, you need to install Bazel in
version 5.3.2, if you don't have it already.
[Follow the instructions for your platform on the Bazel website](https://docs.bazel.build/versions/main/install.html)
In order to run the differential privacy library, you need to install bazelisk,
if you don't have it already. Bazelisk manages [Bazel](https://bazel.build/)
versions and installs correct one.
[Follow the instructions for your platform on the bazelisk github page](https://github.com/bazelbuild/bazelisk?tab=readme-ov-file#installation)

You also need to install Git, if you don't have it already.
[Follow the instructions for your platform on the Git website.](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)

Once you've installed Bazel and Git, open a Terminal and clone the
Once you've installed bazelisk and Git, open a Terminal and clone the
differential privacy directory into a local folder:

```shell
git clone https://github.com/google/differential-privacy.git
```

Navigate into the `differential-privacy` folder you just created,
and build the differential privacy library and dependencies using Bazel
and build the differential privacy library and dependencies using bazelisk
(note: *...* is a part of the command and not a placeholder):

To build the C++ library, run:
```shell
cd cc
bazel build ...
bazelisk build ...
```
To build the Go library, run:
```shell
cd go
bazel build ...
bazelisk build ...
```

To build the Java library, run:
```shell
cd java
bazel build ...
bazelisk build ...
```

To build the PipelineDP4j library, run:
```shell
cd pipelinedp4j
bazel build ...
bazelisk build ...
```

To build Privacy on Beam, run:
```shell
cd privacy-on-beam
bazel build ...
bazelisk build ...
```

You may need to install additional dependencies when building the PostgreSQL
Expand Down
1 change: 1 addition & 0 deletions pipelinedp4j/.bazelversion
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
7.3.1
2 changes: 1 addition & 1 deletion pipelinedp4j/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ You can look at it if you need something beyond the example.

The easiest way to start using the library in your project is to use the
dependency from Maven repository. You can find it
[here](https://mvnrepository.com/artifact/com.google.privacy.differentialprivacy/pipelinedp4j).
[here](https://mvnrepository.com/artifact/com.google.privacy.differentialprivacy.pipelinedp4j/pipelinedp4j).
After adding this dependency into your project you can write the same code as in
the example above and it will compile.

Expand Down

0 comments on commit 0a80e37

Please sign in to comment.