Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dbatten5 committed Mar 17, 2023
1 parent 4d03255 commit 5758714
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,29 @@
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black

Convert a `numpy.NDArray` to various LaTeX forms.

```python
>>> import numpy as np
>>> from arraytex import to_matrix
>>> A = np.array([[1, 2, 3], [4, 5, 6]])
>>> print(to_matrix(A))
\begin{bmatrix}
1 & 2 & 3 \\
4 & 5 & 6 \\
\end{bmatrix}
```

Inspired by @josephcslater's [array_to_latex](https://github.com/josephcslater/array_to_latex).

## Features

- TODO
- Options to use different environment delimiters (`bmatrix` or `pmatrix`) and different
number formatters (`:.2f`, `:.3e`, etc.).

## Requirements

- TODO
- `python >= 3.8`

## Installation

Expand All @@ -39,7 +55,7 @@ $ pip install arraytex

## Usage

Please see the [Command-line Reference] for details.
Please see the [docs](https://arraytex.readthedocs.io/) for more information.

## Contributing

Expand Down
2 changes: 2 additions & 0 deletions src/arraytex/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
"""ArrayTeX."""

from .api import to_matrix

0 comments on commit 5758714

Please sign in to comment.