From 5ccfcc31836b17ef5468ac50839ff484f6f4e253 Mon Sep 17 00:00:00 2001 From: Pierre Blanchard Date: Fri, 9 Aug 2024 10:55:00 +0000 Subject: [PATCH] Improve menu/header consistency, update logos and contributors. --- docs/1-user-guide/README.md | 10 +-- docs/2-references/README.md | 3 +- docs/3-extra/README.md | 4 +- docs/4-tools/README.md | 4 +- docs/5-performance/README.md | 2 +- docs/README.md | 14 +++-- docs/img/naist-logo.svg | 117 ----------------------------------- 7 files changed, 24 insertions(+), 130 deletions(-) delete mode 100644 docs/img/naist-logo.svg diff --git a/docs/1-user-guide/README.md b/docs/1-user-guide/README.md index 7f46d5b4..f16392a3 100644 --- a/docs/1-user-guide/README.md +++ b/docs/1-user-guide/README.md @@ -6,7 +6,9 @@ has_children: true permalink: /1-user-guide/ --- -

Compiling and installing the library

+

User Guide

+ +Guidelines on how to compile and install the library.

Table of contents

@@ -103,7 +105,7 @@ cmake -DSLEEF_BUILD_INLINE_HEADERS=TRUE ..

Compiling the library with Microsoft Visual C++

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. @@ -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" .. &:: If you are using VS2017 -cmake -G"Visual Studio 16 2019" .. &:: 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 ``` diff --git a/docs/2-references/README.md b/docs/2-references/README.md index 3dd9ce6f..e04f1770 100644 --- a/docs/2-references/README.md +++ b/docs/2-references/README.md @@ -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. diff --git a/docs/3-extra/README.md b/docs/3-extra/README.md index 2382ef2c..79884c8b 100644 --- a/docs/3-extra/README.md +++ b/docs/3-extra/README.md @@ -5,7 +5,9 @@ nav_order: 4 permalink: /3-extra/ --- -

Additional Notes

+

Extra

+ +Additional notes on SLEEF components.

Table of contents

diff --git a/docs/4-tools/README.md b/docs/4-tools/README.md index a5027c9d..da2c18e8 100644 --- a/docs/4-tools/README.md +++ b/docs/4-tools/README.md @@ -5,7 +5,9 @@ nav_order: 5 permalink: /4-tools/ --- -

Other tools included in the package

+

Tools

+ +Other tools included in the package.

Table of contents

diff --git a/docs/5-performance/README.md b/docs/5-performance/README.md index 0ca7a309..63692d6d 100644 --- a/docs/5-performance/README.md +++ b/docs/5-performance/README.md @@ -5,7 +5,7 @@ nav_order: 6 permalink: /5-performance/ --- -

Benchmark Results

+

Performance

These graphs show comparison of the execution time between [SLEEF](https://github.com/shibatch/sleef)-3.2 compiled with GCC-7.2 and Intel diff --git a/docs/README.md b/docs/README.md index 35e244f9..a592fd80 100644 --- a/docs/README.md +++ b/docs/README.md @@ -248,8 +248,8 @@ All functions in the library are thread safe unless otherwise noted.

Credit

* The main developer is [Naoki Shibata](https://github.com/shibatch) - ([shibatch@users.sourceforge.net](mailto:shibatch@users.sourceforge.net)) at - Nara Institute of Science and Technology. + ([shibatch@users.sourceforge.net](mailto:shibatch@users.sourceforge.net)) + 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 @@ -257,8 +257,13 @@ All functions in the library are thread safe unless otherwise noted. [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 @@ -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. | diff --git a/docs/img/naist-logo.svg b/docs/img/naist-logo.svg deleted file mode 100644 index b832e37b..00000000 --- a/docs/img/naist-logo.svg +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - -