Merge pull request #12 from biomarkersParkinson/update_readme

Make package citable

CITATION.cff

@@ -0,0 +1,36 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: tsdf4matlab
+abstract: 'A package to load TSDF data into MatLab'
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: Peter
+    family-names: Kok
+    email: [email protected]
+    affiliation: Netherlands eScience Center
+    orcid: 'https://orcid.org/0000-0002-6630-7326'
+  - given-names: Vedran
+    family-names: Kasalica
+    email: [email protected]
+    affiliation: Netherlands eScience Center
+    orcid: 'https://orcid.org/0000-0002-0097-1056'
+  - given-names: Kars
+    family-names: Veldkamp
+    email: [email protected]
+    affiliation: Roudboud University Medical Center
+  - given-names: Nienke
+    family-names: Timmermans
+    email: [email protected]
+    affiliation: Roudboud University Medical Center
+    orcid: 'https://orcid.org/0009-0001-3814-3440'
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.10838512
+repository-code: 'https://github.com/biomarkersParkinson/tsdf'
+url: 'https://biomarkersparkinson.github.io/tsdf/'
+license: Apache-2.0

README.md

@@ -1,8 +1,11 @@
 # Matlab wrapper for the Python [tsdf](https://github.com/biomarkersParkinson/tsdf) library
 
+[![DOI](https://zenodo.org/badge/693538057.svg)](https://zenodo.org/doi/10.5281/zenodo.10838512)
+[![GitHub license](https://img.shields.io/github/license/biomarkersParkinson/tsdf4matlab)](https://github.com/biomarkersparkinson/tsdf4matlab/blob/main/LICENSE)
 
-# Installation
+## Installation
 
+In order to use the [tsdf](https://github.com/biomarkersParkinson/tsdf) library in Matlab, you need to install the `tsdf` library in Python and then link it to MatLab. The following steps will guide you through the installation process.
 
 ### Setting Up MATLAB-Python Integration
 
@@ -30,9 +33,8 @@
    pe = pyenv;
    pe.Version
    ```
-   You should receive confirmation messages indicating the Python version linked to MATLAB.
-
 
+   You should receive confirmation messages indicating the Python version linked to MATLAB.
 
 ### Installing Required Libraries
 
@@ -58,8 +60,6 @@
    subprocess.check_call([sys.executable, '-m', 'pip', 'install','tsdf'])
    ```
 
-
-
 ### Using the MATLAB Wrapper
 
 1. Clone this repository to your local machine.
@@ -71,18 +71,15 @@ addpath('full_path_to_cloned_folder')
 ```
 
 ## Note
+
 We aim to use this tutorial to integrate tsdf into the matlab code:
 
 https://aleksandarhaber.com/tutorial-on-how-to-execute-python-code-directly-matlab/
 
-
-
 The tutorial covers how to import numpy arrays from python code export them from Matlab double. A discussion on the topic is available here:
 
 https://www.mathworks.com/matlabcentral/answers/157347-convert-python-numpy-array-to-double
 
-
-
 Another article that is needed is on how to import python dict into Matlab and how to export them from Matlab struct.
 
 https://nl.mathworks.com/help/matlab/matlab_external/python-dict-variables.html