draft

matlab/README.md

-# Matlab code for time-frequency fading
+# Matlab code for time-frequency fading (TFF)
 
-**********************************************************************************************************************
-* author:  A. Marina KREME	    
-* institution:   Institut de Mathmatiques de Marseille (I2M) / Laboratoire d?Informatique et des systmes (LIS) - Aix-Marseille University, France.
+# TFF: Time Frequency Fading
 
-* date: May, 2020 	    
-% revision date : 
-**********************************************************************************************************************
-***********************************************************************************************************************
-* RECOMMENDATIONS:				                                				
-* This toolbox is designed to work with                                     				   
-* Matlab R2017b (9.3.0.713579) and The Large Time Frequency Analysis Toolbox (LTFAT) which can be downloaded  at  https://ltfat.github.io                    
-***********************************************************************************************************************
+TFF is a toolbox written in Matlab that allows to do time-frequency region 
+filtering out. More precisely, it is a Matlab implementation of the algorithms 
+from Time-frequency fading algorithms based on Gabor multipliers, by,
+A. Marina Krémé, Valentin Emiya, Caroline Chaux, and Bruno Torrésani, 2020. 
 
-----------------------------
+## Installation
 
-# Foobar
 
-Foobar is a Python library for dealing with word pluralization.
 
-## Installation
 
-Use the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar.
 
-```bash
-pip install foobar
-```
 
 ## Usage
+See the documentation.
+
+## Bugs
+Please report any bugs that you find through the skpomade GitLab project.
+You can also fork the repository and create a merge request.
+
+
+## Source code
+The source code of skpomade is available via its GitLab project.
+You can clone the git repository of the project using the command:
+git clone git@gitlab.lis-lab.fr:valentin.emiya/skpomade.git
 
-```python
-import foobar
+## Copyright © 2019-2020
 
-foobar.pluralize('word') # returns 'words'
-foobar.pluralize('goose') # returns 'geese'
-foobar.singularize('phenomena') # returns 'phenomenon'
-```
+Laboratoire d'Informatique et Systèmes
+Institut de Mathématiques de Marseille
+Université d'Aix-Marseille
 
-## Contributing
-Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
-Please make sure to update tests as appropriate.
+## Contributors
 
-## License
-[MIT](https://choosealicense.com/licenses/mit/)
+A. Marina KREME
 
+
+
+
+**********************************************************************************************************************
+* author:  A. Marina KREME	    
+* institution:   Institut de Mathématiques de Marseille (I2M) / Laboratoire d?Informatique et des systèmes (LIS) - Aix-Marseille University, France.
+	     
+* date: May, 2020 	    
+% revision date : 
+**********************************************************************************************************************
+***********************************************************************************************************************
+* RECOMMENDATIONS:				                                				
+* This toolbox is designed to work with                                     				   
+* Matlab R2017b (9.3.0.713579) and The Large Time Frequency Analysis Toolbox (LTFAT) which can be downloaded  at  https://ltfat.github.io                    
+***********************************************************************************************************************
+
+----------------------------