Skip to content

Commit f4ecfd6

Browse files
committed
Fixing README
1 parent d21cae1 commit f4ecfd6

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

README.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
.. Template taken from https://github.com/talmolab/sleap
2-
|conda| |github ci| |Documentation| |PyPI Upload| |Conda Upload| |LICENSE|
1+
|conda| |github ci| |Documentation| |PyPI Upload| |Conda Upload| |LICENSE|;
32

43
.. |github ci| image::
54
https://github.com/kocherlab/naps/actions/workflows/ci.yml/badge.svg?branch=main
@@ -30,6 +29,7 @@
3029
*******************************
3130
NAPS (NAPS is ArUco Plus SLEAP)
3231
*******************************
32+
3333
NAPS is a tool for researchers with two goals: (1) to quantify animal behavior over a long timescale and high resolution, with minimal human bias, and (2) to track the behavior of individuals with a high level of identity-persistence. This could be of use to researchers studying social network analysis, animal communication, task specialization, or gene-by-environment interactions. By combining deep-learning based pose estimation software with easily read and minimally invasive fiducial markers ("tags"), we provide an easy-to-use solution for producing high-quality, high-dimensional behavioral data.
3434

3535
.. figure:: https://naps.readthedocs.io/en/latest/_static/example_tracking.gif
@@ -54,6 +54,7 @@ Features
5454
============
5555
Getting NAPS
5656
============
57+
5758
------------
5859
Easy install
5960
------------
@@ -93,9 +94,10 @@ BibTeX:
9394
======
9495
Issues
9596
======
96-
------------
97+
98+
------------------
9799
Issues with NAPS?
98-
------------
100+
------------------
99101

100102
1. Check the `docs <https://naps.rtfd.io/>`_.
101103
2. Search the `issues on GitHub <https://github.com/kocherlab/naps/issues>`_ or open a new one.

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
license=naps.__license__,
3131
url=naps.__url__,
3232
description=naps.__summary__,
33+
long_description_content_type="text/x-rst",
3334
long_description=readme,
3435
packages=["naps"],
3536
install_requires=requirements,

0 commit comments

Comments
 (0)