diff --git a/README.md b/README.md index d8b5a16cf7..cf0381ee59 100644 --- a/README.md +++ b/README.md @@ -55,28 +55,9 @@ More information can be found at - [Cypher Reference](https://kuzudb.com/docusaurus/cypher/) - [Client APIs](https://kuzudb.com/docusaurus/client-apis/) -## Build -To build from source code, Kùzu requires Cmake(>=3.11), Python 3, and a compiler that supports `C++20`. -- Perform a full clean build without tests and benchmark: - - `make clean && make release` -- Perform a full clean build with tests and benchmark (optional): - - `make clean && make all` -- Run tests (optional): - - `make test && make pytest` +## Build from Source -For development, use `make debug` to build a non-optimized debug version. -To build in parallel, pass `NUM_THREADS` as parameter, e.g., `make NUM_THREADS=8`. - -After build, our CLI binary `kuzu_shell` is available under the directory `build/release/tools/shell/`. - -### Building on Windows -Currently MSVC is the only supported compiler: - -- In addition to the dependencies listed above, you will also need GNU Make and Ninja (E.g. with [Chocolatey](https://community.chocolatey.org/): `choco install make ninja`). -- Build from within a "Visual Studio Developer Command Prompt" (or manually run vcvars64.bat for cmd or Launch-VsDevShell.ps1 for powershell. See [here](https://learn.microsoft.com/en-us/cpp/build/how-to-enable-a-64-bit-visual-cpp-toolset-on-the-command-line?view=msvc-170) and [here](https://learn.microsoft.com/en-us/visualstudio/ide/reference/command-prompt-powershell?view=vs-2022) for details). -- Run `make release`, or the commands listed in the previous section. - -You can also build within Visual Studio, as long as you run `make release` first (or `make debug`), and then use [the CMake plugin](https://learn.microsoft.com/en-us/cpp/build/cmake-projects-in-visual-studio). +Instructions can be found at [Build Kùzu from Source](https://kuzudb.com/docusaurus/development/building-kuzu). ## Contributing We welcome contributions to Kùzu. If you are interested in contributing to Kùzu, please read our [Contributing Guide](CONTRIBUTING.md).