Skip to content
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.

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

chore: Add dependency instructions to bberg README #5187

Merged
merged 2 commits into from
Mar 13, 2024
Merged
Changes from 1 commit
Commits
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
18 changes: 17 additions & 1 deletion barretenberg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,23 @@ Ignores proving key construction.
- libstdc++ >= 12
- libomp (if multithreading is required. Multithreading can be disabled using the compiler flag `-DMULTITHREADING 0`)

#### Ubuntu

To install on Ubuntu, run:

```
sudo apt-get install cmake clang clang-format ninja-build libstdc++-12-dev
```

The default cmake version on 22.04 is 3.22.1, so it must be updated. You can get the latest version [here](https://cmake.org/download).

#### MacOS

When running MacOS Sonoma 14.2.1 the following steps were necessary:
critesjosh marked this conversation as resolved.
Show resolved Hide resolved

- update bash with `brew install bash`
- update [cmake](https://cmake.org/download)

### Installing openMP (Linux)

Install from source:
Expand Down Expand Up @@ -260,16 +271,21 @@ cd barretenberg/cpp
mv build build-native # your native build folders are mounted, but will not work! have to clear them
cmake --preset gcc ; cmake --build build
```

This will allow you to rebuild as efficiently as if you were running native code, and not have to see a full compile cycle.

### Building docs

If doxygen is installed on the system, you can use the **build_docs** target to build documentation, which can be configured in vscode CMake extension or using

```bash
cmake --build . --target build_docs
```

in the cpp/build directory. The documentation will be generated in cpp/docs/build folder. You can then run a python http server in the folder:

```bash
python3 -m http.server <port>
```
and tunnel the port through ssh.

and tunnel the port through ssh.
Loading