Skip to content

Commit 6c5f397

Browse files
committed
fix pypi rendering
1 parent da99993 commit 6c5f397

2 files changed

Lines changed: 9 additions & 8 deletions

File tree

README.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
.. image:: https://raw.githubusercontent.com/Mentalab-hub/explorepy/master/docs/logo.jpg
2-
:scale: 100 %
3-
:align: left
4-
2+
:alt: Explorepy
3+
:target: https://github.com/Mentalab-hub/explorepy
54

65
.. start-badges
76
@@ -39,10 +38,10 @@
3938
4039
4140
=========================
42-
``explorepy`` overview
41+
ExplorePy overview
4342
=========================
4443

45-
``explorepy`` is an open-source Python API designed to collect and process ExG data using Mentalab's Explore device. Amongst other things, ``explorepy`` provides the following features:
44+
ExplorePy is an open-source Python API designed to collect and process ExG data using Mentalab's Explore device. Amongst other things, ExplorePy provides the following features:
4645

4746
* Real-time streaming of ExG, orientation and environmental data.
4847
* Data recording in CSV and BDF+ formats.
@@ -61,7 +60,7 @@ Requirements
6160

6261
Detailed installation instructions can be found on the `installation page <https://explorepy.readthedocs.io/en/latest/installation.html>`_.
6362

64-
To install ``explorepy`` from PyPI run:
63+
To install ExplorePy from PyPI run:
6564
::
6665

6766
pip install explorepy
@@ -78,12 +77,14 @@ Get started
7877

7978
CLI command
8079
-----------
81-
To check ``explorepy`` is running use:
80+
To check ExplorePy is running use:
8281
::
82+
8383
explorepy acquire -n Explore_XXXX
8484

8585
For help, use:
8686
::
87+
8788
explorepy -h
8889

8990

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ build-backend = 'setuptools.build_meta'
66
name = 'explorepy'
77
version = "4.5.0"
88
license = { text = "MIT" }
9-
readme = { file = "README.rst", content-type = "text/markdown" }
9+
readme = { file = "README.rst", content-type = "text/x-rst"}
1010
authors = [
1111
{ name = "MentaLab Hub", email = "support@mentab.org" },
1212
]

0 commit comments

Comments
 (0)