diff --git a/README.md b/README.md index 3cf5e30..61622a8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # latexify + [![Python](https://img.shields.io/pypi/pyversions/latexify-py.svg)](https://pypi.org/project/latexify-py/) [![PyPI Latest Release](https://img.shields.io/pypi/v/latexify-py.svg)](https://pypi.org/project/latexify-py/) [![License](https://img.shields.io/pypi/l/latexify-py.svg)](https://github.com/google/latexify_py/blob/main/LICENSE) @@ -6,7 +7,6 @@ [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) - `latexify` is a Python package to compile a fragment of Python source code to a corresponding $\LaTeX$ expression: @@ -17,7 +17,6 @@ corresponding $\LaTeX$ expression: * Libraries to compile Python source code or AST to $\LaTeX$. * IPython classes to pretty-print compiled functions. - ## FAQs 1. *Which Python versions are supported?* @@ -33,12 +32,13 @@ corresponding $\LaTeX$ expression: `latexify` is based on traditional parsing techniques. If the "AI" meant some techniques around machine learning, the answer is no. - ## Getting started -We prepared a -[Google Colaboratory notebook](https://colab.research.google.com/drive/1MuiawKpVIZ12MWwyYuzZHmbKThdM5wNJ?usp=sharing) -that provides several examples to use this package. +See the [example notebook](examples/latexify_examples.ipynb), which provides several +use-cases of this library. + +You can also try the above notebook on +[Google Colaboratory](https://colab.research.google.com/github/google/latexify_py/blob/main/examples/latexify_examples.ipynb). See also the official [documentation](docs/index.md) for more details. @@ -47,18 +47,16 @@ See also the official [documentation](docs/index.md) for more details. To contribute to this project, please refer [CONTRIBUTING.md](https://github.com/google/latexify_py/blob/develop/CONTRIBUTING.md). - ## Disclaimer -This software is currently hosted on https://github.com/google, but not officially +This software is currently hosted on , but not officially supported by Google. If you have any issues and/or questions about this software, please visit the [issue tracker](https://github.com/google/latexify_py/issues) or contact the [main maintainer](https://github.com/odashi). - -## License +## License This software adopts the [Apache License 2.0](https://github.com/google/latexify_py/blob/develop/LICENSE).