Skip to content

Commit 0a0836f

Browse files
Stash WIP readme changes
1 parent a1afbab commit 0a0836f

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
11
# Recommendation ITU-R P.2108 - U.S. Reference Implementation, Python #
22

3+
![NTIA/ITS PropLib][proplib-badge]
34
![GitHub Release][gh-releases-badge]
45
![GitHub Issues][gh-issues-badge]
5-
6+
<!-- TODO: Add unit test badge after CI workflow is added -->
7+
<!-- [![Unit Tests Status][gh-actions-test-badge]][gh-actions-test-link] -->
8+
<!-- TODO: Include a DOI badge if a DOI exists for a release -->
9+
<!-- [![DOI][doi-badge]][doi-link] -->
10+
11+
[proplib-badge]: https://img.shields.io/badge/NTIA-PropLib-D63E04?label=NTIA%2FITS&labelColor=162E51&link=https%3A%2F%2Fntia.github.io%2Fpropagation-library-wiki
12+
<!--
13+
[gh-actions-test-link]: https://github.com/NTIA/p2108-python/actions/workflows/tox.yml
14+
[gh-actions-test-badge]: https://github.com/NTIA/p2108-python/actions/workflows/tox.yml/badge.svg?branch=main
15+
-->
616
[gh-releases-badge]: https://img.shields.io/github/v/release/NTIA/p2108-python
717
[gh-issues-badge]: https://img.shields.io/github/issues/NTIA/p2108-python
18+
<!-- TODO-TEMPLATE: Only create a DOI for versioned public releases -->
19+
<!-- [doi-badge]: https://zenodo.org/badge/DOI/TODO-TEMPLATE/zenodo.TODO-TEMPLATE.svg
20+
[doi-link]: https://doi.org/TODO-TEMPLATE/zenodo.TODO-TEMPLATE -->
821

922
Python® wrapper for U.S. Reference Software Implementation of Recommendation ITU-R
1023
P.2108. This Recommendation contains three methods for the prediction of clutter
@@ -84,7 +97,7 @@ into the location required by the Python wrapper.
8497
8598
### Running Tests ###
8699
87-
Python unit tests can be run to confirm successfull installation. Test data is
100+
Python unit tests can be run to confirm successful installation. Test data is
88101
expected to be located in the parent repository. Therefore, if you haven't cloned
89102
this repository as a submodule (as described above), you will need to first specify
90103
the location of the test data files in `tests/test_p2108.py` (using the `TEST_DATA_DIR`

0 commit comments

Comments
 (0)