Skip to content

Commit

Permalink
Improve menu/header consistency, update logos and contributors.
Browse files Browse the repository at this point in the history
  • Loading branch information
blapie committed Aug 9, 2024
1 parent 964a0e0 commit 5ccfcc3
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 130 deletions.
10 changes: 6 additions & 4 deletions docs/1-user-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ has_children: true
permalink: /1-user-guide/
---

<h1>Compiling and installing the library</h1>
<h1>User Guide</h1>

Guidelines on how to compile and install the library.

<h2>Table of contents</h2>

Expand Down Expand Up @@ -103,7 +105,7 @@ cmake -DSLEEF_BUILD_INLINE_HEADERS=TRUE ..
<h2 id="MSVC">Compiling the library with Microsoft Visual C++</h2>

You need Visual Studio 2019. Open developer command prompt for VS2019 and
change directory to sleef-3.X. When configuring a build with cmake, you need to
change directory to sleef root. When configuring a build with CMake, you need to
use a specific generator: `cmake -G"Visual Studio 16 2019" ..` This generator
will create a proper solution `SLEEF.sln` under the build directory. You can
still use `cmake --build .` to build the library without opening Visual Studio.
Expand All @@ -113,8 +115,8 @@ Below is an example of commands for building SLEEF with Visual Studio.
```sh
mkdir build
cd build
cmake -G"Visual Studio 15 2017 Win64" .. &amp;:: If you are using VS2017
cmake -G"Visual Studio 16 2019" .. &amp;:: If you are using VS2019
cmake -G"Visual Studio 15 2017 Win64" .. &:: If you are using VS2017
cmake -G"Visual Studio 16 2019" .. &:: If you are using VS2019
cmake --build . --config Release -- /maxcpucount:1
```

Expand Down
3 changes: 2 additions & 1 deletion docs/2-references/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ permalink: /2-references/

# References for Math Libraries

We provide reference for all functions in each component of the SLEEF library.
We provide reference for all functions in each component of the SLEEF math
libraries.

4 changes: 3 additions & 1 deletion docs/3-extra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ nav_order: 4
permalink: /3-extra/
---

<h1>Additional Notes</h1>
<h1>Extra</h1>

Additional notes on SLEEF components.

<h2>Table of contents</h2>

Expand Down
4 changes: 3 additions & 1 deletion docs/4-tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ nav_order: 5
permalink: /4-tools/
---

<h1>Other tools included in the package</h1>
<h1>Tools</h1>

Other tools included in the package.

<h2>Table of contents</h2>

Expand Down
2 changes: 1 addition & 1 deletion docs/5-performance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ nav_order: 6
permalink: /5-performance/
---

<h1>Benchmark Results</h1>
<h1>Performance</h1>

These graphs show comparison of the execution time between
[SLEEF](https://github.com/shibatch/sleef)-3.2 compiled with GCC-7.2 and Intel
Expand Down
14 changes: 9 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,17 +248,22 @@ All functions in the library are thread safe unless otherwise noted.
<h2 id="credit">Credit</h2>

* The main developer is [Naoki Shibata](https://github.com/shibatch)
([[email protected]](mailto:[email protected])) at
Nara Institute of Science and Technology.
([[email protected]](mailto:[email protected]))
formerly at Nara Institute of Science and Technology.

* [Pierre Blanchard](https://github.com/blapie), at Arm Ltd. is the current
global maintainer for SLEEF, alongside
[Joana Cruz](https://github.com/joanaxcruz) and
[Joe Ramsay](https://github.com/joeramsay).

* [Ludovic Henry](https://github.com/luhenry) at Rivos Inc. participated in
adding support for RISC-V vector extensions as well as CI tests based on
Github Actions.
adding support for RISC-V vector extensions as well as a whole new framework
for CI tests based on Github Actions. They provided substantial help to
improve maintainership of the library. Thanks to the RISC-V community,
namely [Eric Love](https://github.com/ericlove) (SiFive),
[@sh1boot](https://github.com/sh1boot), and
[@GlassOfWhiskey](https://github.com/GlassOfWhiskey) for the help in
extending SLEEF support to RISC-V vector extensions.

* [Francesco Petrogalli](https://github.com/fpetrogalli) at ARM Ltd.
contributed the helper for AArch64 (helperadvsimd.h, helpersve.h) and GNUABI
Expand Down Expand Up @@ -287,7 +292,6 @@ All functions in the library are thread safe unless otherwise noted.

| | |
|:-------------:|:------------------|
| [![NAIST logo](img/naist-logo.svg)](https://www.naist.jp/en/) | Division of Information Science of Nara Institute of Science and Technology participates through Naoki Shibata. |
| [![IBM logo](img/ibm-logo.svg)](https://ibm.com) | As the leading company in a wide range of information technologies, [IBM](https://ibm.com/) participates through David Edelsohn. |
| [![ARM logo](img/arm-logo.svg)](https://www.arm.com) | As the leading IP company in semiconductors design, [ARM](https://www.arm.com/) participates through Pierre Blanchard, Joe Ramsay and Joana Cruz. |
| [![Unity Technologies logo](img/unity-logo.svg)](https://unity3d.com) | As the leading company in developing a video game engine, [Unity Technologies](https://unity3d.com/) participates through Alexandre Mutel. |
Expand Down
117 changes: 0 additions & 117 deletions docs/img/naist-logo.svg

This file was deleted.

0 comments on commit 5ccfcc3

Please sign in to comment.