Skip to content

Commit

Permalink
General docs updates
Browse files Browse the repository at this point in the history
Update/fix website.
And a link in markdown doc.
Give more useful cmake command, e.g. static/shared libs.
Fix documented uninstall commands.
  • Loading branch information
blapie committed Jun 7, 2024
1 parent 6012d72 commit 54e82ae
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 8 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,10 @@ cd sleef && mkdir build
cmake -S . -B build
```

By default this will generate shared libraries. In order to generate static libraries, pass option `-DBUILD_SHARED_LIBS=OFF`.

For more verbose output add option `-DSLEEF_SHOW_CONFIG=ON`.

4. Run make to build the project

```
Expand Down Expand Up @@ -192,10 +196,10 @@ spack install sleef@master

### Uninstall

In order to uninstall SLEEF, run
In order to uninstall SLEEF library and headers run

```
sudo xargs rm -v < install_manifest.txt
sudo xargs rm -v < build/install_manifest.txt
```

## License
Expand Down
4 changes: 2 additions & 2 deletions docs/build-with-cmake.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ for one project and manage cross-platform hardware and software complexity.

If you are not already familiar with CMake, please refer to the [official
documentation](https://cmake.org/documentation/) or the
[Basic Introductions](https://cmake.org/Wiki/CMake#Basic_Introductions) in the
wiki (recommended).
[CMake Wiki](https://gitlab.kitware.com/cmake/community/-/wikis/Home)
introduction (recommended).

Before using CMake you will need to install/build the binaries on your system.
Most systems have CMake already installed or provided by the standard package
Expand Down
2 changes: 1 addition & 1 deletion docs/compile.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ $ sudo cmake --install build/ --prefix /path/to/install/dir
In order to uninstall the libraries and headers, run the following command.
</p>

<pre class="command" style="margin-top: 1em;">$ sudo xargs rm -v &lt; install_manifest.txt</pre>
<pre class="command" style="margin-top: 1em;">$ sudo xargs rm -v &lt; build/install_manifest.txt</pre>

<h3 id="lto">Building the library with LTO support</h3>

Expand Down
8 changes: 5 additions & 3 deletions docs/index.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -265,8 +265,8 @@
<tr>
<td class="lt-r" align="left">AArch64, macOS</td>
<td></td>
<td class="lt-lr" align="center"></td>
<td class="lt-r" align="center">Preliminary</td>
<td class="lt-lr" align="center">Supported</td>
<td class="lt-r" align="center">Supported</td>
<td class="lt-r" align="center">N/A</td>
<td class="lt-" align="center">N/A</td>
</tr>
Expand Down Expand Up @@ -328,6 +328,8 @@
<p>
*3 AVX functions are not supported for Cygwin, because AVX is not
supported by Cygwin ABI.
SLEEF also builds with MinGW for Windows on x86, but only DFT can
be tested for now.
</p>

<p>
Expand Down Expand Up @@ -484,7 +486,7 @@ for a full history of changes to SLEEF.</p>

<ul class="disc">
<li>SLEEF is adopted in <a class="underlined"
href="https://youtu.be/QkM6zEGFhDY?t=2328">the Burst Comipler in
href="https://youtu.be/QkM6zEGFhDY?t=2328">the Burst Compiler in
Unity</a>, and also in
the <a class="underlined" href="https://youtu.be/WnJV6J-taIM?t=426">Android
version</a>.</li>
Expand Down

0 comments on commit 54e82ae

Please sign in to comment.