Quellcode durchsuchen

readme: added introduction, badge & test cmds

Fabian Peter Hammerle vor 5 Jahren
Ursprung
Commit
c718fd4e8d
1 geänderte Dateien mit 27 neuen und 0 gelöschten Zeilen
  1. 27 0
      README.md

+ 27 - 0
README.md

@@ -1,3 +1,20 @@
+# freesurfer-surface
+
+[![Build Status](https://travis-ci.org/fphammerle/freesurfer-surface.svg?branch=master)](https://travis-ci.org/fphammerle/freesurfer-surface)
+[![Coverage Status](https://coveralls.io/repos/github/fphammerle/freesurfer-surface/badge.svg?branch=master)](https://coveralls.io/github/fphammerle/freesurfer-surface?branch=master)
+[![Latest PyPI Version](https://img.shields.io/pypi/v/freesurfer-surface.svg)](https://pypi.org/project/freesurfer-surface/#history)
+[![Python Versions](https://img.shields.io/pypi/pyversions/freesurfer-surface.svg)](https://pypi.org/project/freesurfer-surface/)
+
+Python Library to Read and Write Surface Files in Freesurfer’s TriangularSurface Format
+
+Freesurfer https://surfer.nmr.mgh.harvard.edu/
+
+## Install
+
+```sh
+pip3 install --user freesurfer-surface
+```
+
 ## Usage
 
 ### Edit Surface File
@@ -47,3 +64,13 @@ region, = filter(lambda l: l.name == 'precentral',
                  annotation.labels.values())
 print(surface.find_label_border_polygonal_chains(region))
 ```
+
+## Tests
+
+```sh
+pip3 install --user pipenv
+git clone https://github.com/fphammerle/freesurfer-surface.git
+cd freesurfer-surface
+pipenv run pylint freesurfer_surface
+pipenv run pytest --cov=freesurfer_surface
+```