Skip to content

Commit

Permalink
Merge pull request #129 from liuzhenqi77/update-readme
Browse files Browse the repository at this point in the history
[MNT] Update readme
  • Loading branch information
liuzhenqi77 authored Jan 16, 2024
2 parents bad72f7 + 3d014cb commit 4fc46fa
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 11 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: netneurotools tests
name: netneurotools-tests

on:
workflow_dispatch:
push:
branches:
- main
- master
pull_request:

jobs:
Expand Down
33 changes: 24 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,35 @@
netneurotools: Tools for network neuroscience
=============================================

|
.. .. image:: https://zenodo.org/badge/375755159.svg
.. :target: https://zenodo.org/badge/latestdoi/375755159
.. :alt: Zenodo record
.. image:: https://img.shields.io/pypi/v/netneurotools
:target: https://pypi.python.org/pypi/netneurotools/
:alt: Latest PyPI version

.. image:: https://img.shields.io/badge/docker-netneurolab/netneurotools-brightgreen.svg?logo=docker&style=flat
:target: https://hub.docker.com/r/netneurolab/netneurotools/tags/
:alt: Latest Docker image

.. image:: https://github.com/netneurolab/netneurotools/actions/workflows/tests.yml/badge.svg
:target: https://github.com/netneurolab/netneurotools/actions/workflows/tests.yml
:alt: run-tests status

.. image:: https://github.com/netneurolab/netneurotools/actions/workflows/docs.yml/badge.svg
:target: https://netneurolab.github.io/netneurotools/
:alt: deploy-docs status

|
This toolbox is a collection of functions written in Python that get frequent
usage in the `Network Neuroscience Lab <netneurolab.github.io/>`_, housed in
the `Brain Imaging Centre <https://www.mcgill.ca/bic/home>`_ at
`McGill University <https://www.mcgill.ca/>`_.

.. image:: https://github.com/netneurolab/netneurotools/actions/workflows/tests.yml/badge.svg
:target: https://github.com/netneurolab/netneurotools/actions
.. image:: https://codecov.io/gh/netneurolab/netneurotools/branch/master/graph/badge.svg
:target: https://codecov.io/gh/netneurolab/netneurotools
.. image:: https://readthedocs.org/projects/netneurotools/badge/?version=latest
:target: https://netneurotools.readthedocs.io/en/latest
.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
:target: https://opensource.org/licenses/BSD-3-Clause

.. _installation:

Installation
Expand Down

0 comments on commit 4fc46fa

Please sign in to comment.