Skip to content

Commit

Permalink
Fix links in docs and light updates.
Browse files Browse the repository at this point in the history
Change-Id: I7de1554ae78670c3afc60b250fb9f7f3f1ba7df7
  • Loading branch information
blapie committed Jun 5, 2024
1 parent db4f198 commit 3938184
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/build-with-cmake.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ optimized, or any other special set of flags.
* `RelWithDebInfo`: builds optimized code with debug information as well

- `CMAKE_INSTALL_PREFIX`: The prefix the use when running `make install`.
Defaults to /usr/local on GNU/Linux and MacOS.
Defaults to /usr/local on GNU/Linux and macOS.
Defaults to C:/Program Files on Windows.

- `CMAKE_C_FLAGS_RELEASE` : The optimization options used by the compiler.
Expand Down
24 changes: 15 additions & 9 deletions docs/compile.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<li><a class="underlined" href="compile.xhtml">Compiling and installing the library</a></li>
<ul class="disc">
<li><a href="#preliminaries">Preliminaries</a></li>
<li><a href="#cmakevars">Common CMake variables</a></li>
<li><a href="#quickstart">Quick start</a></li>
<li><a href="#linux">Compiling and installing the library on Linux</a></li>
<li><a href="#MSVC">Compiling the library with Microsoft Visual C++</a></li>
<li><a href="#hello">Compiling and running "Hello SLEEF"</a></li>
Expand Down Expand Up @@ -62,22 +62,30 @@ the <a class="underlined" href="https://gitlab.kitware.com/cmake/community/-/wik
introductions in the wiki</a>.
</p>

<h2>Quick start</h2>
<h2 id="quickstart">Quick start</h2>

<p class="noindent">
You will find quick start instructions in the sources or via GitHub in the
<a class="underlined" href="https://github.com/shibatch/sleef/blob/master/README.md">README.md</a>
file.
</p>

<p class="noindent">
A more detailed description of CMake usage is provided in the
<a class="underlined" href="https://github.com/shibatch/sleef/blob/master/docs/build-with-cmake.md">docs/build-with-cmake.md</a>
file, along with
<a class="underlined" href="https://github.com/shibatch/sleef/blob/master/docs/build-with-cmake.md#sleef-variables">a list of CMake variables</a>
relevant to users.
</p>

<h2 id="linux">Compiling and installing the library on Linux</h2>

<p class="noindent">
In order to build the library, you need to install OpenMP. In order
to test the library, you need to install libmpfr, libssl and
libfftw3. Availability of these libraries are checked upon execution
of cmake. Please change the directory to sleef-3.X and run the
following commands.
In order to build the library, you may want to install OpenMP (optional).
In order to test the library, you need to install libmpfr, libssl and
libfftw3 (optional). Availability of these libraries are checked upon
execution of cmake.
Please change the directory to sleef-3.X and run the following commands.

<pre class="command">$ sudo apt-get install libmpfr-dev libssl-dev libfftw3-dev
$ cmake -S . -B build/ ..
Expand All @@ -87,8 +95,6 @@ $ sudo cmake --install build/ --prefix /path/to/install/dir
</pre>
</p>

<br/>

<p>
In order to uninstall the libraries and headers, run the following command.
</p>
Expand Down

0 comments on commit 3938184

Please sign in to comment.