Skip to content

Commit

Permalink
Merge pull request #19 from BrainLesion/enahnce-readme
Browse files Browse the repository at this point in the history
Enhance readme
  • Loading branch information
MarcelRosier authored Aug 6, 2024
2 parents 6c28e1c + b941cae commit df36a4d
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 7 deletions.
5 changes: 1 addition & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![License: GPLv3](https://img.shields.io/badge/License-AGPLv3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
[![License: GPLv3](https://img.shields.io/badge/License-AGPLv3-blue.svg?color=2EC553)](https://www.gnu.org/licenses/agpl-3.0)

# Contributing to BraTS

First off, thanks for taking the time to contribute! 🎉

## Reporting Bugs, Feature Requests and Questions
Please open a new issue [here](https://github.com/BrainLesion/BraTS/issues).
Using our issue templates will make the process easier and faster for us all!

## Contribute Code
Fork the repository, clone it and implement your contribution.
Expand Down
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[![PyPI version brats-algorithms](https://badge.fury.io/py/brats.svg)](https://pypi.python.org/pypi/brats/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/brats?logo=python&color=2EC553)](https://pypi.org/project/brats/)
[![Documentation Status](https://readthedocs.org/projects/brats/badge/?version=latest)](http://brats.readthedocs.io/?badge=latest)
[![tests](https://github.com/BrainLesion/brats/actions/workflows/tests.yml/badge.svg)](https://github.com/BrainLesion/brats/actions/workflows/tests.yml)
[![PyPI version brats-algorithms](https://badge.fury.io/py/brats.svg)](https://pypi.python.org/pypi/brats/)
[![License: GPLv3](https://img.shields.io/badge/License-AGPLv3-blue.svg?color=2EC553)](https://www.gnu.org/licenses/agpl-3.0)

# BraTS

Expand Down Expand Up @@ -61,7 +63,20 @@ For more examples and details please refer to our extensive Notebook tutorials [
| | 2023 | 2nd | Andriy Myronenko, et al. | N/A | :heavy_multiplication_x: |
| | 2023 | 3rd | Fadillah Adamsyah Maani, et al. | N/A | :heavy_multiplication_x: |

## Citation
If you use BraTS in your research, please cite it to support the development!

```
TODO: citation will be added asap
```


## Contributing

We welcome contributions from the community, including bug reports, feature requests, and code contributions.
For more information on how to contribute, please see our [CONTRIBUTING.md](CONTRIBUTING.md) file.
We welcome all kinds if contributions from the community!

### Reporting Bugs, Feature Requests and Questions
Please open a new issue [here](https://github.com/BrainLesion/BraTS/issues).

### Code contributions
Nice to have you on board! Please have a look at our [CONTRIBUTING.md](CONTRIBUTING.md) file.

0 comments on commit df36a4d

Please sign in to comment.