From 95cb11870277db432d0e15a6e9405cbc5c439d53 Mon Sep 17 00:00:00 2001 From: John Brownlee Date: Tue, 27 Mar 2018 16:19:03 -0700 Subject: [PATCH 1/2] Adds instructions on building on the Mac. --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 68edc85987..4f2d344628 100755 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ # FoundationDB FoundationDB is a distributed database designed to handle large volumes of structured data across clusters of commodity servers. It organizes data as an ordered key-value store and employs ACID transactions for all operations. It is especially well-suited for read/write workloads but also has excellent performance for write-intensive workloads. Users interact with the database using API language binding. + +# Building Locally + +## macOS + +1. Check out this repo on your Mac. +2. Install the Xcode command-line tools. +3. Download version 1.52 of [Boost](https://sourceforge.net/projects/boost/files/boost/1.52.0/). +4. Set the BOOSTDIR environment variable to the location containing this boost installation. +5. Install [Mono](http://www.mono-project.com/download/stable/). +6. Install a [JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html). FoundationDB currently builds with Java 8. +7. Navigate to the directory where you checked out the foundationdb repo. +8. Run `make`. + +This will build the fdbserver binary and the python bindings. If you +want to build our other bindings, you will need to install a runtime for the +language whose binding you want to build. Each binding has an `.mk` file +which provides specific targets for that binding. \ No newline at end of file From b853308a8df59b3628c06368cb1e4285ae2dcb46 Mon Sep 17 00:00:00 2001 From: John Brownlee Date: Fri, 30 Mar 2018 12:40:08 -0700 Subject: [PATCH 2/2] Formatting changes to the README. --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4f2d344628..6c1009ec42 100755 --- a/README.md +++ b/README.md @@ -6,14 +6,14 @@ FoundationDB is a distributed database designed to handle large volumes of struc ## macOS -1. Check out this repo on your Mac. -2. Install the Xcode command-line tools. -3. Download version 1.52 of [Boost](https://sourceforge.net/projects/boost/files/boost/1.52.0/). -4. Set the BOOSTDIR environment variable to the location containing this boost installation. -5. Install [Mono](http://www.mono-project.com/download/stable/). -6. Install a [JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html). FoundationDB currently builds with Java 8. -7. Navigate to the directory where you checked out the foundationdb repo. -8. Run `make`. +1. Check out this repo on your Mac. +1. Install the Xcode command-line tools. +1. Download version 1.52 of [Boost](https://sourceforge.net/projects/boost/files/boost/1.52.0/). +1. Set the BOOSTDIR environment variable to the location containing this boost installation. +1. Install [Mono](http://www.mono-project.com/download/stable/). +1. Install a [JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html). FoundationDB currently builds with Java 8. +1. Navigate to the directory where you checked out the foundationdb repo. +1. Run `make`. This will build the fdbserver binary and the python bindings. If you want to build our other bindings, you will need to install a runtime for the