diff --git a/BUILDING.md b/BUILDING.md deleted file mode 100644 index 91db823c..00000000 --- a/BUILDING.md +++ /dev/null @@ -1,202 +0,0 @@ -# Building Codex - -## Table of Contents - -- [Install developer tools](#prerequisites) - - [Linux](#linux) - - [macOS](#macos) - - [Windows + MSYS2](#windows--msys2) - - [Other](#other) -- [Clone and prepare the Git repository](#repository) -- [Build the executable](#executable) -- [Run the example](#example-usage) - -**Optional** -- [Run the tests](#tests) - -## Prerequisites - -To build nim-codex, developer tools need to be installed and accessible in the OS. - -Instructions below correspond roughly to environmental setups in nim-codex's [CI workflow](https://github.com/codex-storage/nim-codex/blob/main/.github/workflows/ci.yml) and are known to work. - -Other approaches may be viable. On macOS, some users may prefer [MacPorts](https://www.macports.org/) to [Homebrew](https://brew.sh/). On Windows, rather than use MSYS2, some users may prefer to install developer tools with [winget](https://docs.microsoft.com/en-us/windows/package-manager/winget/), [Scoop](https://scoop.sh/), or [Chocolatey](https://chocolatey.org/), or download installers for e.g. Make and CMake while otherwise relying on official Windows developer tools. Community contributions to these docs and our build system are welcome! - -### Rust - -The current implementation of Codex's zero-knowledge proving circuit requires the installation of rust v1.76.0 or greater. Be sure to install it for your OS and add it to your terminal's path such that the command `cargo --version` gives a compatible version. - -### Linux - -*Package manager commands may require `sudo` depending on OS setup.* - -On a bare bones installation of Debian (or a distribution derived from Debian, such as Ubuntu), run - -```shell -$ apt-get update && apt-get install build-essential cmake curl git rustc cargo -``` - -Non-Debian distributions have different package managers: `apk`, `dnf`, `pacman`, `rpm`, `yum`, etc. - -For example, on a bare bones installation of Fedora, run - -```shell -dnf install @development-tools cmake gcc-c++ rust cargo -``` - -In case your distribution does not provide required Rust version, we may install it using [rustup](https://www.rust-lang.org/tools/install) -```shell -curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs/ | sh -s -- --default-toolchain=1.76.0 -y - -. "$HOME/.cargo/env" -``` - -### macOS - -Install the [Xcode Command Line Tools](https://mac.install.guide/commandlinetools/index.html) by opening a terminal and running -```shell -xcode-select --install -``` - -Install [Homebrew (`brew`)](https://brew.sh/) and in a new terminal run -```shell -brew install bash cmake rust -``` - -Check that `PATH` is setup correctly -```shell -which bash cmake - -# /usr/local/bin/bash -# /usr/local/bin/cmake -``` - -### Windows + MSYS2 - -*Instructions below assume the OS is 64-bit Windows and that the hardware or VM is [x86-64](https://en.wikipedia.org/wiki/X86-64) compatible.* - -Download and run the installer from [msys2.org](https://www.msys2.org/). - -Launch an MSYS2 [environment](https://www.msys2.org/docs/environments/). UCRT64 is generally recommended: from the Windows *Start menu* select `MSYS2 MinGW UCRT x64`. - -Assuming a UCRT64 environment, in Bash run -```shell -pacman -Suy -pacman -S base-devel git unzip mingw-w64-ucrt-x86_64-toolchain mingw-w64-ucrt-x86_64-cmake mingw-w64-ucrt-x86_64-rust -``` - - - - - -#### Optional: VSCode Terminal integration - -You can link the MSYS2-UCRT64 terminal into VSCode by modifying the configuration file as shown below. -File: `C:/Users//AppData/Roaming/Code/User/settings.json` -```json -{ - ... - "terminal.integrated.profiles.windows": { - ... - "MSYS2-UCRT64": { - "path": "C:\\msys64\\usr\\bin\\bash.exe", - "args": [ - "--login", - "-i" - ], - "env": { - "MSYSTEM": "UCRT64", - "CHERE_INVOKING": "1", - "MSYS2_PATH_TYPE": "inherit" - } - } - } -} -``` - -### Other - -It is possible that nim-codex can be built and run on other platforms supported by the [Nim](https://nim-lang.org/) language: BSD family, older versions of Windows, etc. There has not been sufficient experimentation with nim-codex on such platforms, so instructions are not provided. Community contributions to these docs and our build system are welcome! - -## Repository - -In Bash run -```shell -git clone https://github.com/codex-storage/nim-codex.git repos/nim-codex && cd repos/nim-codex -``` - -nim-codex uses the [nimbus-build-system](https://github.com/status-im/nimbus-build-system), so next run -```shell -make update -``` - -This step can take a while to complete because by default it builds the [Nim compiler](https://nim-lang.org/docs/nimc.html). - -To see more output from `make` pass `V=1`. This works for all `make` targets in projects using the nimbus-build-system -```shell -make V=1 update -``` - -## Executable - -In Bash run -```shell -make -``` - -The default `make` target creates the `build/codex` executable. - -## Example usage - -See the [instructions](README.md#cli-options) in the main readme. - -## Tests - -In Bash run -```shell -make test -``` - -### Tools - -#### Circuit download tool - -To build the circuit download tool located in `tools/cirdl` run: - -```shell -make cirdl -``` - -### testAll - -#### Prerequisites - -To run the integration tests, an Ethereum test node is required. Follow these instructions to set it up. - -##### Windows (do this before 'All platforms') - -1. Download and install Visual Studio 2017 or newer. (Not VSCode!) In the Workloads overview, enable `Desktop development with C++`. ( https://visualstudio.microsoft.com ) - -##### All platforms - -1. Install NodeJS (tested with v18.14.0), consider using NVM as a version manager. [Node Version Manager (`nvm`)](https://github.com/nvm-sh/nvm#readme) -1. Open a terminal -1. Go to the vendor/codex-contracts-eth folder: `cd //vendor/codex-contracts-eth/` -1. `npm install` -> Should complete with the number of packages added and an overview of known vulnerabilities. -1. `npm test` -> Should output test results. May take a minute. - -Before the integration tests are started, you must start the Ethereum test node manually. -1. Open a terminal -1. Go to the vendor/codex-contracts-eth folder: `cd //vendor/codex-contracts-eth/` -1. `npm start` -> This should launch Hardhat, and output a number of keys and a warning message. - -#### Run - -The `testAll` target runs the same tests as `make test` and also runs tests for nim-codex's Ethereum contracts, as well a basic suite of integration tests. - -To run `make testAll`. - -Use a new terminal to run: -```shell -make testAll -``` diff --git a/README.md b/README.md index 22cbe219..2e5b74b2 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ ## Build and Run -For detailed instructions on preparing to build nim-codex see [*Building Codex*](BUILDING.md). +For detailed instructions on preparing to build nim-codex see [*Build Codex*](https://docs.codex.storage/learn/build). To build the project, clone it and run: