diff --git a/README.md b/README.md index de9070ac0f..f63c21459e 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Pageserver consists of: ## Running local installation -#### building on Linux +#### Installing dependencies on Linux 1. Install build dependencies and other useful packages * On Ubuntu or Debian this set of packages should be sufficient to build the code: @@ -49,14 +49,7 @@ dnf install flex bison readline-devel zlib-devel openssl-devel \ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh ``` -3. Build neon and patched postgres -```sh -git clone --recursive https://github.com/neondatabase/neon.git -cd neon -make -j`nproc` -``` - -#### building on OSX (12.3.1) +#### Installing dependencies on OSX (12.3.1) 1. Install XCode and dependencies ``` xcode-select --install @@ -76,10 +69,19 @@ brew install libpq brew link --force libpq ``` -4. Build neon and patched postgres -```sh +#### Building on Linux and OSX + +1. Build neon and patched postgres +``` +# Note: The path to the neon sources can not contain a space. + git clone --recursive https://github.com/neondatabase/neon.git cd neon + +# The preferred and default is to make a debug build. This will create a +# demonstrably slower build than a release build. If you want to use a release +# build, utilize "`BUILD_TYPE=release make -j`nproc``" + make -j`nproc` ``` @@ -209,7 +211,7 @@ Same applies to certain spelling: i.e. we use MB to denote 1024 * 1024 bytes, wh To get more familiar with this aspect, refer to: - [Neon glossary](/docs/glossary.md) -- [PostgreSQL glossary](https://www.postgresql.org/docs/13/glossary.html) +- [PostgreSQL glossary](https://www.postgresql.org/docs/14/glossary.html) - Other PostgreSQL documentation and sources (Neon fork sources can be found [here](https://github.com/neondatabase/postgres)) ## Join the development