Skip to content

Commit

Permalink
Merge pull request #136 from bradh/docs_F
Browse files Browse the repository at this point in the history
doc: trivial typo fixes
  • Loading branch information
aous72 authored Apr 28, 2024
2 parents 4e13575 + a684bc8 commit cd15fb3
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/compiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ To install either use

cmake --install . --prefix <your folder>

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 .

Expand Down Expand Up @@ -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 #
Expand Down
2 changes: 1 addition & 1 deletion docs/doxygen_style.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/status.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down

0 comments on commit cd15fb3

Please sign in to comment.