Browse Source

readme: added short description

Fabian Peter Hammerle 5 years ago
parent
commit
cabe40ccff
2 changed files with 8 additions and 1 deletions
  1. 7 0
      README.md
  2. 1 1
      freesurfer_volume_reader/__init__.py

+ 7 - 0
README.md

@@ -1,3 +1,10 @@
+# freesurfer-volume-reader
+
+Python script & library to
+read hippocampal subfield volumes computed by Freesurfer
+
+https://surfer.nmr.mgh.harvard.edu/fswiki/HippocampalSubfields
+
 ## Install
 
 ```sh

+ 1 - 1
freesurfer_volume_reader/__init__.py

@@ -58,7 +58,7 @@ def read_hippocampal_volume_file_dataframe(volume_file_path: str) -> pandas.Data
 
 def main():
     argparser = argparse.ArgumentParser(
-        description='Read hippocampal volumes computed by Freesurfer'
+        description='Read hippocampal subfield volumes computed by Freesurfer'
                     '\nhttps://surfer.nmr.mgh.harvard.edu/fswiki/HippocampalSubfields')
     argparser.add_argument('--filename-regex', dest='filename_pattern',
                            default=DEFAULT_HIPPOCAMPAL_VOLUME_FIND_FILENAME_PATTERN,