Skip to content

Commit

Permalink
Issue #44 tidied readme
Browse files Browse the repository at this point in the history
  • Loading branch information
thompson318 committed Jul 27, 2022
1 parent 4308cb2 commit 2d421c4
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 11 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ We welcome contributions to scikit-surgerytf.
Reporting bugs and feature requests
-----------------------------------

Please create a new issue on https://github.com/UCL/scikit-surgerytf/issues/new
Please create a new issue on https://github.com/SciKit-Surgery/scikit-surgerytf/issues/new

When reporting a bug, please include:
* The version of scikit-surgerytf you are using
Expand All @@ -23,13 +23,13 @@ Fixing bugs or implement features

The easiest way to contribute is to follow these guidelines:

1. Look through the issues on https://github.com/UCL/scikit-surgerytf/issues and assign the relevant issue to yourself. If there is not an existing issue that covers your work, please create one: https://github.com/UCL/scikit-surgerytf/issues/new
1. Look through the issues on https://github.com/SciKit-Surgery/scikit-surgerytf/issues and assign the relevant issue to yourself. If there is not an existing issue that covers your work, please create one: https://github.com/SciKit-Surgery/scikit-surgerytf/issues/new
2. Read the design considerations below.
3. Fork the repository: https://github.com/UCL/scikit-surgerytf/forks/new
3. Fork the repository: https://github.com/SciKit-Surgery/scikit-surgerytf/forks/new
4. Create a branch for your changes. The branch name should start with the issue number, followed by hyphen separated words describing the issue. For example: 1-update-contribution-guidelines
5. Make your changes following the coding guidelines below.
6. Commit and push your changes to your fork. The commit message should start with `Issue #<issue number>`, for example: "Issue #1: Fixed typo". Commit in small, related chunks. Review each commit and explain its purpose in the commit message.
7. Submit a merge request: https://github.com/UCL/scikit-surgerytf/merge_requests/new
7. Submit a merge request: https://github.com/SciKit-Surgery/scikit-surgerytf/merge_requests/new

Design Considerations
---------------------
Expand Down
23 changes: 16 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ scikit-surgerytf
:target: https://github.com/UCL/scikit-surgerytf
:alt: Logo

|
.. image:: https://github.com/UCL/scikit-surgerytf/workflows/.github/workflows/ci.yml/badge.svg
:target: https://github.com/UCL/scikit-surgerytf/actions
:alt: GitHub Actions CI status
Expand All @@ -19,10 +21,17 @@ scikit-surgerytf
:target: http://scikit-surgerytf.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
:target: CODE_OF_CONDUCT.md

.. image:: https://img.shields.io/twitter/follow/scikit_surgery?style=social
:target: https://twitter.com/scikit_surgery?ref_src=twsrc%5Etfw
:alt: Follow scikit_surgery on twitter


Author: Matt Clarkson

scikit-surgerytf is part of the `SNAPPY`_ software project, developed at the `Wellcome EPSRC Centre for Interventional and Surgical Sciences`_, part of `University College London (UCL)`_.
scikit-surgerytf is part of the `SciKit-Surgery`_ software project, developed at the `Wellcome EPSRC Centre for Interventional and Surgical Sciences`_, part of `University College London (UCL)`_.

scikit-surgerytf supports Python 3.6+, and tensorflow >= 2.0.0.

Expand Down Expand Up @@ -130,7 +139,7 @@ You can clone the repository using the following command:

::

git clone https://github.com/UCL/scikit-surgerytf
git clone https://github.com/SciKit-Surgery/scikit-surgerytf


Running tests
Expand All @@ -153,7 +162,7 @@ You can pip install directly from the repository as follows:

::

pip install git+https://github.com/UCL/scikit-surgerytf
pip install git+https://github.com/SciKit-Surgery/scikit-surgerytf



Expand Down Expand Up @@ -184,12 +193,12 @@ Supported by `Wellcome`_ and `EPSRC`_.


.. _`Wellcome EPSRC Centre for Interventional and Surgical Sciences`: http://www.ucl.ac.uk/weiss
.. _`source code repository`: https://github.com/UCL/scikit-surgerytf
.. _`source code repository`: https://github.com/Scikit-Surgery/scikit-surgerytf
.. _`Documentation`: https://scikit-surgerytf.readthedocs.io
.. _`SNAPPY`: https://weisslab.cs.ucl.ac.uk/WEISS/PlatformManagement/SNAPPY/wikis/home
.. _`SciKit-Surgery`: https://github.com/SciKit-Surgery
.. _`University College London (UCL)`: http://www.ucl.ac.uk/
.. _`Wellcome`: https://wellcome.ac.uk/
.. _`EPSRC`: https://www.epsrc.ac.uk/
.. _`contributing guidelines`: https://github.com/UCL/scikit-surgerytf/blob/master/CONTRIBUTING.rst
.. _`contributing guidelines`: https://github.com/SciKit-Surgery/scikit-surgerytf/blob/master/CONTRIBUTING.rst
.. _`license file`: https://github.com/UCL/scikit-surgerytf/blob/master/LICENSE
.. _`PythonTemplate`: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/PythonTemplate
.. _`PythonTemplate`: https://github.com/SciKit-Surgery/PythonTemplate

0 comments on commit 2d421c4

Please sign in to comment.