diff --git a/Makefile b/Makefile index 1444075..11f30ec 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ FROM = markdown_phpextra+backtick_code_blocks+footnotes -all: cl-simd.html cl-simd.pdf +all: README.html README.pdf %.html: %.md Makefile pandoc -f $(FROM) $< -o $@ %.pdf: %.md Makefile diff --git a/README b/README deleted file mode 100644 index 0837cac..0000000 --- a/README +++ /dev/null @@ -1,8 +0,0 @@ -This module implements SSE intrinsic functions for ECL and SBCL. - -NOTE: CURRENTLY THIS SHOULD BE CONSIDERED EXPERIMENTAL, AND - SUBJECT TO INCOMPATIBLE CHANGES IN A FUTURE RELEASE. - -Since the implementation is closely tied to the internals of -the compiler, it should normally be obtained exclusively via -the bundled contrib mechanism of the above implementations. diff --git a/cl-simd.html b/README.html similarity index 95% rename from cl-simd.html rename to README.html index e569ae7..91f52ae 100644 --- a/cl-simd.html +++ b/README.html @@ -1,7 +1,9 @@

cl-simd

-

The cl-simd module provides access to SSE2 instructions (which are nowadays supported by any CPU compatible with x86-64) in the form of intrinsic functions, similar to the way adopted by modern C compilers. It also provides some lisp-specific functionality, like setf-able intrinsics for accessing lisp arrays.

-

When this module is loaded, it defines an :sse2 feature, which can be subsequently used for conditional compilation of code that depends on it. Intrinsic functions are available from the sse package.

+

This library implements SSE intrinsic functions for ECL and SBCL. It provides access to SSE2 instructions (which are nowadays supported by any CPU compatible with x86-64) in the form of intrinsic functions, similar to the way adopted by modern C compilers. It also provides some lisp-specific functionality, like setf-able intrinsics for accessing lisp arrays.

This API, with minor technical differences, is supported by both ECL and SBCL (x86-64 only).

+

When this module is loaded, it defines an :sse2 feature, which can be subsequently used for conditional compilation of code that depends on it. Intrinsic functions are available from the sse package.

+

NOTE: CURRENTLY THIS SHOULD BE CONSIDERED EXPERIMENTAL, AND SUBJECT TO INCOMPATIBLE CHANGES IN A FUTURE RELEASE.

+

Since the implementation is closely tied to the internals of the compiler, it should normally be obtained exclusively via the bundled contrib mechanism of the above implementations.

SSE pack types

The package defines and/or exports the following types to represent 128-bit SSE register contents:

diff --git a/cl-simd.md b/README.md similarity index 91% rename from cl-simd.md rename to README.md index 949e53c..3fdd022 100644 --- a/cl-simd.md +++ b/README.md @@ -1,18 +1,26 @@ cl-simd ========= -The `cl-simd` module provides access to SSE2 instructions (which are -nowadays supported by any CPU compatible with x86-64) in the form of -_intrinsic functions_, similar to the way adopted by modern C compilers. -It also provides some lisp-specific functionality, like setf-able -intrinsics for accessing lisp arrays. - - When this module is loaded, it defines an `:sse2` feature, which can -be subsequently used for conditional compilation of code that depends on -it. Intrinsic functions are available from the `sse` package. - - This API, with minor technical differences, is supported by both ECL -and SBCL (x86-64 only). +This library implements SSE intrinsic functions for ECL and SBCL. +It provides access to SSE2 instructions (which are nowadays supported by +any CPU compatible with x86-64) in the form of _intrinsic functions_, +similar to the way adopted by modern C compilers. It also provides some +lisp-specific functionality, like setf-able intrinsics for accessing +lisp arrays. + +This API, with minor technical differences, is supported by both ECL and +SBCL (x86-64 only). + +When this module is loaded, it defines an `:sse2` feature, which can be +subsequently used for conditional compilation of code that depends on it. +Intrinsic functions are available from the `sse` package. + +NOTE: CURRENTLY THIS SHOULD BE CONSIDERED EXPERIMENTAL, AND + SUBJECT TO INCOMPATIBLE CHANGES IN A FUTURE RELEASE. + +Since the implementation is closely tied to the internals of the compiler, +it should normally be obtained exclusively via the bundled contrib +mechanism of the above implementations. SSE pack types ------------------ diff --git a/cl-simd.pdf b/README.pdf similarity index 93% rename from cl-simd.pdf rename to README.pdf index 5c71882..ab9cb4a 100644 Binary files a/cl-simd.pdf and b/README.pdf differ