Skip to content

Installation guide updates/fixing link to installations #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MYousuf3 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Installation guide updates/fixing link to installations #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
18 changes: 9 additions & 9 deletions docs/docs/getting-started/getting-started/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,14 +216,14 @@ <h2 id="mac-pre-requisities">
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">xcode-select --install
</code></pre></div><p>Homebrew is &ldquo;The Missing Package Manager for macOS&rdquo; which will make installing lots of things easy. Install like this:</p>
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">/bin/bash -c <span style="color:#e6db74">&#34;</span><span style="color:#66d9ef">$(</span>curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh<span style="color:#66d9ef">)</span><span style="color:#e6db74">&#34;</span>
</code></pre></div><p>You can then use it to install CMake and gfortran:</p>
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">brew install cmake gfortran
</code></pre></div><p>You can then use it to install CMake, gfortran, and pkg-config:</p>
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">brew install cmake gfortran pkg-config
</code></pre></div><h2 id="linux-pre-requisites">
Linux Pre-requisites
<a class="anchor" href="#linux-pre-requisites">#</a>
</h2>
<p>You&rsquo;ll need Git, CMake, GCC, gfortran, etc.</p>
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">sudo apt install git cmake pkg-config gfortran curl zip unzip tar build-essential
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">sudo apt install git cmake pkg-config gfortran curl zip unzip tar build-essential ninja-build
</code></pre></div><h2 id="windows-installation">
Windows Installation
<a class="anchor" href="#windows-installation">#</a>
Expand All @@ -234,17 +234,17 @@ <h2 id="downloading-the-library">
<a class="anchor" href="#downloading-the-library">#</a>
</h2>
<p>First, clone the repository along with submodules:</p>
<pre><code>git clone https://github.com/cloctools/lds-ctrl-est.git
cd lds-ctrl-est
git submodule update --init
<pre><code>git clone https://github.com/cloctools/lds-ctrl-est.git
cd lds-ctrl-est
git submodule update --init
</code></pre><h2 id="compilation--installation">
Compilation + Installation
<a class="anchor" href="#compilation--installation">#</a>
</h2>
<p>Now generate the cache and build using your IDE or from the command line as follows.</p>
<pre><code class="language-source" data-lang="source">mkdir build &amp;&amp; cd build
cmake ..
cmake --build .
<pre><code class="language-source" data-lang="source">mkdir build &amp;&amp; cd build
cmake ..
cmake --build .
</code></pre><p>The first time, <code>vcpkg</code> will automatically install dependencies into <code>[build directory]/vcpkg_installed/</code>, which will likely take about 10-20 minutes.</p>
<p>If you want to use <code>vcpkg</code> set up somewhere besides this repo&rsquo;s submodule, add <code>-DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake</code> to the <code>cmake</code> command directly or <a href="https://github.com/microsoft/vcpkg#using-vcpkg-with-cmake">through your IDE&rsquo;s settings</a>.</p>
<p>You can verify the build is working by running <code>ctest</code> from the build folder, which runs all the example scripts.</p>
Expand Down