Skip to content

Commit a7e4764

Browse files
committed
link migration guide in readme & docs front page
1 parent b33c54b commit a7e4764

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
<source media="(prefers-color-scheme: dark)" srcset="./docs/source/_static/superneuro-pcg-arrow-dark-tag.svg">
44
<img alt="SuperNeuroMAT Logo" src="./docs/source/_static/superneuro-pcg-arrow-blue-tag.svg" width='600rem'>
55
</picture>
6-
7-
The Super Speedy Spike Simulator.
86
</div>
97

108
# SuperNeuroMAT
119

10+
### The Super Speedy Spike Simulator.
11+
1212
SuperNeuroMAT is a Python package for simulating and analyzing spiking neural networks.
1313

1414
[![Tox: Selected Tests](https://github.com/ORNL/superneuromat/actions/workflows/test.yaml/badge.svg)](https://github.com/ORNL/superneuromat/actions/workflows/test.yaml)
@@ -56,6 +56,8 @@ from superneuromat import SNN
5656

5757
See the [tutorial](https://ORNL.github.io/superneuromat/guide/firstrun.html) for more.
5858

59+
Additionally, the [migration guide](https://ornl.github.io/superneuromat/guide/migration2.html) may be of use to those coming from older versions of SuperNeuroMAT.
60+
5961
## Citation
6062
1. Please cite SuperNeuroMAT using:
6163
```

docs/source/guide/migration2.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ Migrating from older versions of SuperNeuroMAT
55
.. currentmodule:: superneuromat
66

77

8-
This page describes the necessary changes to migrate your code from SuperNeuroMAT v1.x.x to v2.1.0.
8+
This page describes the necessary changes to migrate your code from SuperNeuroMAT v1.x.x to the latest version, v\ |release|.
99

10-
Only breaking changes are covered here.
10+
Only breaking changes are covered on this page.
11+
12+
For more information on the changes, see the GitHub release notes: https://github.com/ORNL/superneuromat/releases.
1113

1214

1315
``2.0.x`` to ``3.x.x``

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Then, you can import the :py:mod:`superneuromat` package:
4747
4848
from superneuromat import SNN
4949
50+
For those coming from older versions of SuperNeuroMAT, see the :doc:`migration guide <guide/migration2>`.
5051

5152
Cite SuperNeuroMAT
5253
------------------

0 commit comments

Comments
 (0)