diff --git a/README.md b/README.md index 62d4a0ef..209bd44c 100755 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Among other things, this project also does not provide methods for trajectory op # Installation -See the [documentation](https://cloctools.github.io/docs/getting-started). +See the [documentation](https://cloctools.github.io/lds-ctrl-est/docs/getting-started/getting-started/). # Reporting Issues If you encounter bugs when using this library or have specific feature requests that you believe fall within the stated scope of this project, please [open an issue on GitHub](https://github.com/cloctools/lds-ctrl-est/issues) and use an appropriate issue template where possible. You may also fork the repository and submit pull-requests with your suggested changes. diff --git a/docs/docs/getting-started/getting-started/index.html b/docs/docs/getting-started/getting-started/index.html index 85282b68..5f3de8bf 100644 --- a/docs/docs/getting-started/getting-started/index.html +++ b/docs/docs/getting-started/getting-started/index.html @@ -216,14 +216,14 @@

xcode-select --install
 

Homebrew is “The Missing Package Manager for macOS” which will make installing lots of things easy. Install like this:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
-

You can then use it to install CMake and gfortran:

-
brew install cmake gfortran
+

You can then use it to install CMake, gfortran, and pkg-config:

+
brew install cmake gfortran pkg-config
 

Linux Pre-requisites #

You’ll need Git, CMake, GCC, gfortran, etc.

-
sudo apt install git cmake pkg-config gfortran curl zip unzip tar build-essential
+
sudo apt install git cmake pkg-config gfortran curl zip unzip tar build-essential ninja-build
 

Windows Installation # @@ -234,17 +234,17 @@

#

First, clone the repository along with submodules:

-
git clone https://github.com/cloctools/lds-ctrl-est.git 
-cd lds-ctrl-est
-git submodule update --init
+
git clone https://github.com/cloctools/lds-ctrl-est.git 
+cd lds-ctrl-est
+git submodule update --init
 

Compilation + Installation #

Now generate the cache and build using your IDE or from the command line as follows.

-
mkdir build && cd build
-cmake ..
-cmake --build .
+
mkdir build && cd build
+cmake ..
+cmake --build .
 

The first time, vcpkg will automatically install dependencies into [build directory]/vcpkg_installed/, which will likely take about 10-20 minutes.

If you want to use vcpkg set up somewhere besides this repo’s submodule, add -DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake to the cmake command directly or through your IDE’s settings.

You can verify the build is working by running ctest from the build folder, which runs all the example scripts.