From fb3e15e8ee1d5fe6cdfee8315c5d625fe569ba7e Mon Sep 17 00:00:00 2001 From: James Ravenscroft Date: Wed, 12 Apr 2023 07:36:03 +0100 Subject: [PATCH] added some guidance for building on mac to build.md --- BUILD.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/BUILD.md b/BUILD.md index 1a7d05f..56e2439 100644 --- a/BUILD.md +++ b/BUILD.md @@ -6,6 +6,8 @@ TurboPilot is a C++ program that uses the [GGML](https://github.com/ggerganov/gg To build turbopilot you will need CMake, Libboost, a C++ toolchain and GNU Make. +#### Ubuntu + On Ubuntu you can install these things with: ```bash @@ -13,6 +15,14 @@ sudo apt-get update sudo apt-get install libboost-dev cmake build-essential ``` +#### MacOS + +If you use [brew](https://brew.sh/) you can simply add these dependencies by running: + +```bash +brew install cmake boost +``` + ### Checkout Submodules Make sure the ggml subproject is checked out with `git submodule init` and `git submodule update` @@ -24,9 +34,11 @@ Configure cmake to build the project with the following: ```bash mkdir ggml/build cd ggml/build -cmake -D CMAKE_EXE_LINKER_FLAGS="-static" .. +cmake .. ``` +If you are running on linux you can optionally compile a static build with `cmake -D CMAKE_EXE_LINKER_FLAGS="-static" ..` which should make your binary portable across different flavours of the OS. + From here you can now build the components that make up turbopilot: ```bash