Skip to content

Commit

Permalink
Updated readme/changelog for new release.
Browse files Browse the repository at this point in the history
Updated example images.
  • Loading branch information
kostub committed Aug 29, 2016
1 parent 3efa116 commit 32073c9
Show file tree
Hide file tree
Showing 19 changed files with 101 additions and 5 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
## Changelog

### v0.9.0 (2016-08-29)
* Added support for matrix environments (matrix, pmatrix, bmatrix,
Bmatrix, vmatrix, Vmatrix)
* Added support for equation alignment (eqalign, displaylines, gather,
split, aligned, eqnarray)
* Added support for the \\\\ command to split long equations
* Added support for math accents (e.g. \\hat, \\tilde etc.)
* Added support for `cases` environment.
* Added support for style commands (e.g. \\displaystyle etc.)
* Improve rendering of square roots and large symbols
* API changes:
* Updated API for `MTMathAtomFactory`.
* Rename `MTLargeGlyphDisplay` to `MTGlyphDisplay`

### v0.8.4 (2016-08-10)
* Fix crash for \\epsilon and \\varrho
* Add commands: \\mho, \\angstrom and \\AA
Expand Down
81 changes: 81 additions & 0 deletions EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,13 @@ x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}

![Limit](img/limit.png)

## Calculus
```LaTeX
f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi
```

![Calculus](img/calculus.png)

## Stirling Numbers of the Second Kind
```LaTeX
{n \brace k} = \frac{1}{k!}\sum_{j=0}^k (-1)^{k-j}\binom{k}{j}(k-j)^n
Expand Down Expand Up @@ -88,4 +95,78 @@ i\hbar\frac{\partial}{\partial t}\Psi(x,t) = -\frac{\hbar}{2m}\nabla^2\Psi(x,t)

![Schroedinger](img/schroedinger.png)

## Lorentz Equations
Use the `gather` or `displaylines` environments to center multiple
equations.
```LaTeX
\begin{gather}
\dot{x} = \sigma(y-x) \\
\dot{y} = \rho x - y - xz \\
\dot{z} = -\beta z + xy"
\end{gather}
```

![Lorentz](img/lorentz.png)

## Cross product
```LaTeX
\vec V_1 \times \vec V_2 = \begin{vmatrix}
\hat \imath &\hat \jmath &\hat k \\
\frac{\partial X}{\partial u} & \frac{\partial Y}{\partial u} & 0 \\
\frac{\partial X}{\partial v} & \frac{\partial Y}{\partial v} & 0
\end{vmatrix}
```

![Cross Product](img/cross.png)

## Maxwell's Equations
Use the `aligned`, `eqalign` or `split` environments to align
multiple equations.
```LaTeX
\begin{eqalign}
\nabla \cdot \vec{E} & = \frac {\rho} {\varepsilon_0} \\
\nabla \cdot \vec{B} & = 0 \\
\nabla \times \vec{E} &= - \frac{\partial\vec{B}}{\partial t} \\
\nabla \times \vec{B} & = \mu_0\vec{J} + \mu_0\varepsilon_0 \frac{\partial\vec{E}}{\partial t}
\end{eqalign}
```

![Maxwell's Equations](img/maxwell.png)

## Matrix multiplication
Supported matrix environments: `matrix`, `pmatrix`, `bmatrix`, `Bmatrix`,
`vmatrix`, `Vmatrix`.
```LaTeX
\begin{pmatrix}
a & b\\ c & d
\end{pmatrix}
\begin{pmatrix}
\alpha & \beta \\ \gamma & \delta
\end{pmatrix} =
\begin{pmatrix}
a\alpha + b\gamma & a\beta + b \delta \\
c\alpha + d\gamma & c\beta + d \delta
\end{pmatrix}
```

![Matrix Multiplication](img/matrixmult.png)

## Cases
```LaTeX
f(x) = \begin{cases}
\frac{e^x}{2} & x \geq 0 \\
1 & x < 0
\end{cases}
```

![Cases](img/cases.png)

## Splitting long equations
```LaTeX
Q(\lambda,\hat{\lambda}) =
-\frac{1}{2} P(O \mid \lambda ) \sum_s \sum_m \sum_t \gamma_m^{(s)} (t) +\\
\quad \left( \log(2 \pi ) + \log \left| C_m^{(s)} \right| +
\left( o_t - \hat{\mu}_m^{(s)} \right) ^T C_m^{(s)-1} \right)
```

![Long equation](img/long.png)
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ library:

![Quadratic Formula](img/quadratic.png)

![Gauss Integral](img/gaussintegral.png)
![Calculus](img/calculus.png)

![AM-GM](img/amgm.png)

Expand Down Expand Up @@ -99,6 +99,9 @@ This is a list of formula types that the library currently supports:
* Ratios, proportions, percents
* Math spacing
* Overline and underline
* Math accents
* Matrices
* Equation alignment
* Most commonly used math symbols

### Example
Expand Down Expand Up @@ -191,11 +194,9 @@ some important pieces that are missing and will be included in future
updates. This includes:

* Support for explicit big delimiters (bigl, bigr etc.)
* Math accents
* Aligning equations
* Some symbols are not yet included
* Matrices
* Constructing tall radicals and delimiters
* Support for specifing fonts such as `\cal` or `\rm`
* Addition of missing plain TeX commands

## Related Projects

Expand Down
Binary file modified img/amgm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/calculus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/cases.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/cauchyintegral.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/cauchyschwarz.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/cross.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/gaussintegral.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/limit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/long.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/lorentz.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/matrixmult.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/maxwell.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/quadratic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/ramanujan.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/standard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/stirling.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 32073c9

Please sign in to comment.