Skip to content

Commit

Permalink
Add badges to doc homepage
Browse files Browse the repository at this point in the history
  • Loading branch information
mhostetter committed Nov 30, 2023
1 parent 36f3f56 commit 9b41a86
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
.. image:: ../logo/galois-heading.png
:align: center

.. raw:: html

<div align=center>
<a href="https://pypi.org/project/galois"><img src="https://img.shields.io/pypi/v/galois"></a>
<a href="https://pypi.org/project/galois"><img src="https://img.shields.io/pypi/pyversions/galois"></a>
<a href="https://pypi.org/project/galois"><img src="https://img.shields.io/pypi/wheel/galois"></a>
<a href="https://pypistats.org/packages/galois"><img src="https://img.shields.io/pypi/dm/galois"></a>
<a href="https://pypi.org/project/galois"><img src="https://img.shields.io/pypi/l/galois"></a>
<a href="https://twitter.com/galois_py"><img src="https://img.shields.io/static/v1?label=follow&message=@galois_py&color=blue&logo=twitter"></a>
<a href="https://github.com/mhostetter/galois/actions/workflows/docs.yaml"><img src="https://github.com/mhostetter/galois/actions/workflows/docs.yaml/badge.svg"></a>
<a href="https://github.com/mhostetter/galois/actions/workflows/lint.yaml"><img src="https://github.com/mhostetter/galois/actions/workflows/lint.yaml/badge.svg"></a>
<a href="https://github.com/mhostetter/galois/actions/workflows/build.yaml"><img src="https://github.com/mhostetter/galois/actions/workflows/build.yaml/badge.svg"></a>
<a href="https://github.com/mhostetter/galois/actions/workflows/test.yaml"><img src="https://github.com/mhostetter/galois/actions/workflows/test.yaml/badge.svg"></a>
<a href="https://codecov.io/gh/mhostetter/galois"><img src="https://codecov.io/gh/mhostetter/galois/branch/main/graph/badge.svg?token=3FJML79ZUK"></a>
</div>

The :obj:`galois` library is a Python 3 package that extends NumPy arrays to operate over finite fields.

The user creates a :obj:`~galois.FieldArray` subclass using `GF = galois.GF(p**m)`. `GF` is a subclass of :obj:`numpy.ndarray`
Expand Down

0 comments on commit 9b41a86

Please sign in to comment.