diff --git a/matlab/README.md b/matlab/README.md index 46f01b2cf65e842504cd683985f33bf3ba288197..cbb77dd8d0fa740a1dc38f0b0351e8248c09cc7e 100644 --- a/matlab/README.md +++ b/matlab/README.md @@ -1,2 +1,47 @@ # Matlab code for time-frequency fading +********************************************************************************************************************** +* 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 +*********************************************************************************************************************** + +---------------------------- + +# 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 + +```python +import foobar + +foobar.pluralize('word') # returns 'words' +foobar.pluralize('goose') # returns 'geese' +foobar.singularize('phenomena') # returns 'phenomenon' +``` + +## 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. + +## License +[MIT](https://choosealicense.com/licenses/mit/) +