Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
limefrogyank authored Nov 19, 2024
1 parent 4939e55 commit fb2a337
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ https://limefrogyank.github.io/siunitx-pcc/

## Description

This is a project being funded by Portland Community College to be completed end of summer 2023. The goal is to make it free and open-source, but licensing is currently pending. The intent is for it to be used in authoring online, OER (open educational resource), _accessible_ textbooks.
This is a project being funded by Portland Community College to be completed end of summer 2023. The goal is to make it free and open-source. The intent is for it to be used in authoring online, OER (open educational resource), _accessible_ textbooks.

This is a port of [Joseph Wright's siunitx package for LaTeX](https://github.com/josephwright/siunitx) that will work with the [MathJax](https://www.mathjax.org/) v3+ extension system. As a result it is written entirely in TypeScript. His siunitx pdf documents were used to make this port as close as possible to the original with some caveats:

* MathJax is math mode only, so features like tables won't work and are not implemented
* The evaluate function is running on a javascript engine instead of the LaTeX compiler so beware the differences
* Using curly braces to encapsulate options for `\\sisetup` is not supported here. Instead, use a new set of MathJax delimiters (`$`,`$$`, etc) to reset options for the new block of LaTeX.

## To Use

Expand Down Expand Up @@ -146,4 +147,4 @@ This line should come before you add anything else and will do the same thing as

## To Build Yourself

Clone the repo, make sure you have nodejs, then `npm run build` . This will generate the 'siunitx.js' file that's already in the root folder.
Clone the repo, make sure you have nodejs, then `npm run build` . This will generate the 'siunitx.js' file that's already in the root folder.

0 comments on commit fb2a337

Please sign in to comment.