From a684bc8f9a46e8a2eaefcdca6a08975a44a07626 Mon Sep 17 00:00:00 2001 From: Brad Hards Date: Sun, 28 Apr 2024 20:44:15 +1000 Subject: [PATCH] doc: trivial typo fixes --- docs/compiling.md | 4 ++-- docs/doxygen_style.md | 2 +- docs/status.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/compiling.md b/docs/compiling.md index d4058aaf..4a772acf 100644 --- a/docs/compiling.md +++ b/docs/compiling.md @@ -29,7 +29,7 @@ To install either use cmake --install . --prefix -to install the library to your desired folder, or, if you want to install to C:\Program Files, you need a PwoerShell/CMD running as administrator, and +to install the library to your desired folder, or, if you want to install to C:\Program Files, you need a PowerShell/CMD running as administrator, and cmake --install . @@ -69,7 +69,7 @@ before compilation. Then, emcmake cmake .. emmake make -Compilation will generate two version of the library and executables, one with WebAssembly SIMD isntructions and one without. +Compilation will generate two version of the library and executables, one with WebAssembly SIMD instructions and one without. # Compiling to javascript/wasm # diff --git a/docs/doxygen_style.md b/docs/doxygen_style.md index d9c27e80..032ae35c 100644 --- a/docs/doxygen_style.md +++ b/docs/doxygen_style.md @@ -2,7 +2,7 @@ Documentation is still experimental for me, and I might change things down the line. -Here, we describe how to document the source code. This represent so sort of minial set of markers that need to be used. Other markers can be used to enhance the documentation of the code. This serves as a live document that can be updated when needed. +Here, we describe how to document the source code. This represent so sort of minimal set of markers that need to be used. Other markers can be used to enhance the documentation of the code. This serves as a live document that can be updated when needed. I am preferencing `@` over `\`. ## Comment block diff --git a/docs/status.md b/docs/status.md index ee665584..d1ba0913 100644 --- a/docs/status.md +++ b/docs/status.md @@ -1,6 +1,6 @@ # Status # -The code is written in C++; the color and wavelet transform steps can employ SIMD instructions on Intel platforms. SIMD instuctions are also available for the block decoder (SSE3) and for the block encoder (AVX512). Other parts of the library may include SIMD in the future, for Intel and ARM; existing implementations can also be improved as there is still decent performance improvements on the table. SIMD instructions are also employed for WebAssembly (Emscripten-based), which is now widely supported in most browsers. +The code is written in C++; the color and wavelet transform steps can employ SIMD instructions on Intel platforms. SIMD instructions are also available for the block decoder (SSE3) and for the block encoder (AVX512). Other parts of the library may include SIMD in the future, for Intel and ARM; existing implementations can also be improved as there is still decent performance improvements on the table. SIMD instructions are also employed for WebAssembly (Emscripten-based), which is now widely supported in most browsers. The encoder supports lossless and quantization-based lossy encoding. There is currently no implementation for rate-control-based encoding.