From 0d737e59a339324acacec2918380ff486d12aa37 Mon Sep 17 00:00:00 2001 From: Shane Maloney Date: Sun, 2 Jun 2024 15:01:24 +0100 Subject: [PATCH] Trivial update for publishing (#70) * Update README * Add change log --- README.rst | 11 ++++++++++- changelog/{67.feature.rst => 67.breaking.rst} | 0 changelog/70.trivial.rst | 1 + setup.cfg | 2 +- 4 files changed, 12 insertions(+), 2 deletions(-) rename changelog/{67.feature.rst => 67.breaking.rst} (100%) create mode 100644 changelog/70.trivial.rst diff --git a/README.rst b/README.rst index 3e6b705..25947e7 100644 --- a/README.rst +++ b/README.rst @@ -28,19 +28,28 @@ Installation It is strongly advised that you use and isolated environment through python's venv, virturalenv, anaconda or similar. + +**The name 'xrayvision' was already taken on PyPi so the package name is 'xrayvisim' e.g.** + .. code-block:: - pip install xrayvision + pip install xrayvisim Usage ----- +See the `example gallery`_. + Getting Help ------------ +See the `issue tracker`_. + Contributing ------------ When you are interacting with the community you are asked to follow the `Code of Conduct`_. .. _Code of Conduct: http://docs.sunpy.org/en/stable/coc.html +.. _example gallery: https://xrayvision.readthedocs.io/en/latest/generated/gallery/index.html +.. _issue tracker: https://github.com/TCDSolar/xrayvision/issues diff --git a/changelog/67.feature.rst b/changelog/67.breaking.rst similarity index 100% rename from changelog/67.feature.rst rename to changelog/67.breaking.rst diff --git a/changelog/70.trivial.rst b/changelog/70.trivial.rst new file mode 100644 index 0000000..5befa80 --- /dev/null +++ b/changelog/70.trivial.rst @@ -0,0 +1 @@ +Update README with useful links to example and issue tracker. diff --git a/setup.cfg b/setup.cfg index 28af907..90fd67f 100644 --- a/setup.cfg +++ b/setup.cfg @@ -4,7 +4,7 @@ author = Shane Maloney author_email = shane.maloney@dias.ie license = BSD 3-Clause license_files = LICENSE.rst -url = https://xrayvision.readthedocs.io/en/latest/ +url = https://github.com/TCDSolar/xrayvision description = An open-source Python library for Fourier or synthesis X-Ray imaging instruments. long_description = file: README.rst long_description_content_type = text/x-rst