From 6d1a3c06defc5c9d5478611a680d23fba5b1c687 Mon Sep 17 00:00:00 2001 From: Josh Crites Date: Wed, 13 Mar 2024 09:22:51 -0400 Subject: [PATCH 1/2] add dependency instructions --- barretenberg/README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/barretenberg/README.md b/barretenberg/README.md index e8d553b2772..68fef367404 100644 --- a/barretenberg/README.md +++ b/barretenberg/README.md @@ -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: + +- update bash with `brew install bash` +- update [cmake](https://cmake.org/download) + ### Installing openMP (Linux) Install from source: @@ -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 ``` -and tunnel the port through ssh. \ No newline at end of file + +and tunnel the port through ssh. From 5391c3be1be24c2013d754c07bdd765a08d314dd Mon Sep 17 00:00:00 2001 From: josh crites Date: Wed, 13 Mar 2024 11:43:51 -0400 Subject: [PATCH 2/2] Update barretenberg/README.md Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com> --- barretenberg/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/barretenberg/README.md b/barretenberg/README.md index 68fef367404..a4603487035 100644 --- a/barretenberg/README.md +++ b/barretenberg/README.md @@ -61,7 +61,7 @@ The default cmake version on 22.04 is 3.22.1, so it must be updated. You can get #### MacOS -When running MacOS Sonoma 14.2.1 the following steps were necessary: +When running MacOS Sonoma 14.2.1 the following steps are necessary: - update bash with `brew install bash` - update [cmake](https://cmake.org/download)