From 1a865112983bea2bd64e36dc34ac783488eef46e Mon Sep 17 00:00:00 2001 From: xckev Date: Sun, 26 Jan 2025 13:48:13 -0800 Subject: [PATCH 1/2] new install instructions --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6d60e33d..bda74111 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ You need Linux or macOS. On Windows, we recommend installing the Windows Subsyst - (Recommended) ASAN (Address Sanitizer). We use this to catch memory errors early. `apt install libasan`. (If you wish to use LOST without the address sanitizer, build it with `make LOST_DISABLE_ASAN=1`, or set `export LOST_DISABLE_ASAN=1` in your `~/.bashrc` file to disable it every time you build). - Git. On Debian, `apt install git` - Cairo, to read and write PNGs as well as draw on them for debugging and demo purposes. You won't - need this on your CubeSat. On Debian, `apt install libcairo2-dev`. Elsewhere, follow the + need this on your CubeSat. On Debian, `sudo apt-get install libcairo2-dev`. Elsewhere, follow the instructions here: https://www.cairographics.org/download/ under the Binary Packages section. - Eigen3, a header-only linear algebra and numerical methods library. On Debian, `apt install libeigen3-dev`. Elsewhere, download the latest stable release from https://eigen.tuxfamily.org/. @@ -37,10 +37,12 @@ You need Linux or macOS. On Windows, we recommend installing the Windows Subsyst - Download [Homebrew](https://brew.sh/), run `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"` in terminal - Install [cairo](https://formulae.brew.sh/formula/cairo#default) via homebrew `brew install cairo` + - Locate the cairo folder within the 'include' directory of the installed cairo package. Move it into the vendor directory so that the cairo files are in `vendor/cairo` under the LOST repository - Install [Eigen]("https://formulae.brew.sh/formula/eigen#default") via homebrew `brew install eigen` - - Locate Eigen files and move them to `vendor/eigen3/Eigen` under the LOST repository + - Locate the eigen3 folder within the 'include' directory of the installed Eigen package. Move it into the vendor directory so that the eigen files are in `vendor/eigen3/Eigen` under the LOST repository - Install [groff]("https://formulae.brew.sh/formula/groff#default") via homebrew `brew install groff` - If you get errors mentioning 'ASAN' or 'AddressSanitizer', try `make clean` and then `make LOST_DISABLE_ASAN=1` to disable ASAN. See the Linux section above for more details. +- If you an error like `error: linker command failed with exit code 1` or `library 'cairo' not found`, set LIBS in the Makefile to `LIBS = -L/opt/homebrew/lib -lcairo` and add a line `CFLAGS = -I/opt/homebrew/include/cairo` under it. ### Building From 2f97e0384d53daf9a27b5a8594b5ceb9f7b2e069 Mon Sep 17 00:00:00 2001 From: xckev Date: Sun, 26 Jan 2025 13:52:35 -0800 Subject: [PATCH 2/2] apple silicon specifier --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bda74111..a6db7864 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ You need Linux or macOS. On Windows, we recommend installing the Windows Subsyst - Locate the eigen3 folder within the 'include' directory of the installed Eigen package. Move it into the vendor directory so that the eigen files are in `vendor/eigen3/Eigen` under the LOST repository - Install [groff]("https://formulae.brew.sh/formula/groff#default") via homebrew `brew install groff` - If you get errors mentioning 'ASAN' or 'AddressSanitizer', try `make clean` and then `make LOST_DISABLE_ASAN=1` to disable ASAN. See the Linux section above for more details. -- If you an error like `error: linker command failed with exit code 1` or `library 'cairo' not found`, set LIBS in the Makefile to `LIBS = -L/opt/homebrew/lib -lcairo` and add a line `CFLAGS = -I/opt/homebrew/include/cairo` under it. +- On Apple Silicon, if you an error like `error: linker command failed with exit code 1` or `library 'cairo' not found`, set LIBS in the Makefile to `LIBS = -L/opt/homebrew/lib -lcairo` and add a line `CFLAGS = -I/opt/homebrew/include/cairo` under it. ### Building