https://github.com/wunkolo/intriman

Intriman is a documentation generator that retargets the Intel Intrinsics Guide to other documentation formats
https://github.com/wunkolo/intriman

documen intel intrinsic simd

Last synced: about 1 year ago
JSON representation

Intriman is a documentation generator that retargets the Intel Intrinsics Guide to other documentation formats

• Host: GitHub
• URL: https://github.com/wunkolo/intriman
• Owner: Wunkolo
• License: mit
• Created: 2017-12-21T09:54:47.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-06-15T19:03:25.000Z (about 4 years ago)
• Last Synced: 2025-03-31T05:24:57.443Z (about 1 year ago)
• Topics: documen, intel, intrinsic, simd
• Language: C++
• Homepage:
• Size: 67.4 KB
• Stars: 28
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Intriman [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

Intriman is a documentation generator that retargets the [Intel Intrinsics Guide](https://software.intel.com/sites/landingpage/IntrinsicsGuide/) data into additional **offline** documentation formats.

---

Man page(groff):

![](media/manpage.png)

Markdown:

![](media/markdown.png)

Plaintext:

![](media/plaintext.png)

---

## Dependencies

 * [Cmake 3.2.2+](https://www.cmake.org/download/)

 * [pugixml](https://github.com/zeux/pugixml)

## Building

Clone the repository with submodules:

`git clone --recursive https://github.com/Wunkolo/Intriman.git`

### Windows

Using Visual Studio 2017, simply open `CMakeLists.txt` using Visual Studios [built-in support for opening CMake projects](https://blogs.msdn.microsoft.com/vcblog/2016/10/05/cmake-support-in-visual-studio/):

![](https://i.imgur.com/NmnwidH.png)

Finally, select your desired build target and architecture and then build. Compiled binaries will be found in the cache folder:

![](https://i.imgur.com/binVwSK.png)

![](https://i.imgur.com/Ad0KG7t.png)

![](https://i.imgur.com/Lyqmwbi.png)

### Linux

Typical [Cmake out-of-source build procedure](http://preshing.com/20170511/how-to-build-a-cmake-based-project/#running-cmake-from-the-command-line):

```

cd Intriman

mkdir build

cd build

cmake ..

make

```

## Usage

CMake generation should automatically download `data-latest.xml` from Intel.

Otherwise, download the file from `https://software.intel.com/sites/landingpage/IntrinsicsGuide/files/data-latest.xml` and simply drag and drop this file onto the executable, or put `data-latest.xml` as the first argument(`Intriman data-latest.xml`), and the documentation files will be generated( default output directory is `./docs/` relative to the executable path )

![](https://i.imgur.com/YwGg9y0.png)

![](https://i.imgur.com/OOE9HrB.gif)

![](https://i.imgur.com/fa1bm4M.gif)