Skip to content

Commit ef682a1

Browse files
committed
Update documentation
1 parent 47a3b2e commit ef682a1

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

Documentation/appendix.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22
Appendix
33
========
44

5+
Related Software
6+
================
7+
* shr-parser_: A Rust library for parsing SHR files.
8+
* shr-parser-py_: Another Python package for parsing SHR files written in Rust. This project is no longer
9+
maintained at the time of writing.
10+
11+
.. _shr-parser: https://github.com/Xerrion/shr_parser
12+
.. _shr-parser-py: https://pypi.org/project/shr-parser/
13+
514
License
615
=======
716
Copyright (c) 2025, WiSELab-CMU

Documentation/pyshrparser.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ This installs a package that can be used from Python (``import shr_parser``).
3434
To install for all users on the system, administrator
3535
rights (root) may be required.
3636

37-
From PyPI (Not published yet. This doesn't work yet)
37+
From PyPI
3838
----------------------------------------------------
3939
pyshrparser can be installed from PyPI::
4040

41-
pip install pyshrparser
42-
python3 -m pip install pyshrparser
41+
pip install py-shr-parser
42+
python3 -m pip install py-shr-parser
4343

4444
Developers also may be interested to get the source archive, because it
4545
contains examples, tests and this documentation.

0 commit comments

Comments
 (0)