From ab709afeb6189b4ca649e8013de24b410165412c Mon Sep 17 00:00:00 2001 From: Georgia R <61972664+CoachGeorgia@users.noreply.github.com> Date: Wed, 16 Mar 2022 10:55:16 -0400 Subject: [PATCH 1/2] Update CMakeLists.txt.googletest Fix broken reference GIT Tag from "master" to new "main" --- CMakeLists.txt.googletest | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CMakeLists.txt.googletest b/CMakeLists.txt.googletest index f98ccb4..37b622b 100644 --- a/CMakeLists.txt.googletest +++ b/CMakeLists.txt.googletest @@ -5,11 +5,11 @@ project(googletest-download NONE) include(ExternalProject) ExternalProject_Add(googletest GIT_REPOSITORY https://github.com/google/googletest.git - GIT_TAG master + GIT_TAG main SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}/googletest-src" BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/googletest-build" CONFIGURE_COMMAND "" BUILD_COMMAND "" INSTALL_COMMAND "" TEST_COMMAND "" -) \ No newline at end of file +) From 0152a9aac55cd9bc64029c63847eebbb3f6e80aa Mon Sep 17 00:00:00 2001 From: Georgia R <61972664+CoachGeorgia@users.noreply.github.com> Date: Wed, 16 Mar 2022 11:37:21 -0400 Subject: [PATCH 2/2] Update README.md --- README.md | 42 ++++++++++++++++++++++++++++++------------ 1 file changed, 30 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 71a4257..ffd04df 100644 --- a/README.md +++ b/README.md @@ -17,37 +17,55 @@ Each function has a commented section above it explaining the inputs required fo The primary purpose of the provided software is to be easy to read and educational, reinforcing the concepts in the book. The code is optimized neither for efficiency nor robustness. -## Installation +## Installation -### 1. Install Eigen library. -* On Mac +### 1. Install Software +* Eigen Library: On Linux and Mac ```console -foo@bar:~$ brew install eigen +foo@bar:~$ sudo apt-get install libeigen3-dev ``` -* On Linux +* Eigen Libray: Mac ```console -foo@bar:~$ sudo apt-get install libeigen3-dev +foo@bar:~$ brew install eigen ``` -### 2. Prepare build +* cmake: On Linux +```console +foo@bar:~$ sudo apt-get install cmake +``` ```console foo@bar:~$ mkdir build && cd build ``` -By default cmake will install our build into the system directories. -To define a custom install directory we simply pass it to cmake: +### 2. Download Repo +* Download Repo: +```console +foo@bar:~$ +``` +* Extract Repo: +```console +foo@bar:~$ sudo unzip +``` + +### 3. Prepare build ```console -foo@bar:build $ cmake .. -DCMAKE_INSTALL_PREFIX=../_install +foo@bar:~$ mkdir build && cd build ``` + Or just configure with defaults ```console foo@bar:build $ cmake .. ``` -Building and installing library +Building library +```console +foo@bar:build $ sudo make +``` +Installing library ```console -foo@bar:build $ make all && make install +foo@bar:build $ sudo make install ``` + ## Testing the library ```console foo@bar:build $ ./lib_test