Logo (#165)

N-Wouda · Aug 19, 2023 · db88880 · db88880
1 parent b933ed2
commit db88880
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+![ALNS logo](docs/source/assets/images/logo.svg)
+
 [![PyPI version](https://badge.fury.io/py/alns.svg)](https://badge.fury.io/py/alns)
 [![ALNS](https://github.com/N-Wouda/ALNS/actions/workflows/alns.yaml/badge.svg)](https://github.com/N-Wouda/ALNS/actions/workflows/alns.yaml)
 [![Documentation Status](https://readthedocs.org/projects/alns/badge/?version=latest)](https://alns.readthedocs.io/en/latest/?badge=latest)

diff --git a/docs/source/assets/images/icon.svg b/docs/source/assets/images/icon.svg
diff --git a/docs/source/assets/images/logo.svg b/docs/source/assets/images/logo.svg
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,5 +1,6 @@
-ALNS
-====
+.. figure:: assets/images/logo.svg
+   :alt: ALNS logo
+   :figwidth: 100%
 
 ``alns`` is a general, well-documented and tested implementation of the adaptive large neighbourhood search (ALNS) metaheuristic in Python.
 ALNS is an algorithm that can be used to solve difficult combinatorial optimisation problems.