diff --git a/python/README.rst b/python/README.rst index 52bdfa3221c87a2edd4ed3010b15a5fc2cbaa1f3..b3abd2755399aeb7c401c029d5000ebd060b91e0 100755 --- a/python/README.rst +++ b/python/README.rst @@ -2,9 +2,9 @@ tffpy ===== A Python package for time-frequency fading using Gabor multipliers based on -the work in paper Time-frequency fading algorithms based on Gabor -multipliers by A. Marina Krémé, Valentin Emiya, Caroline Chaux and Bruno -Torré́sani, 2020. +the work in paper *Time-frequency fading algorithms based on Gabor +multipliers* by A. Marina Krémé, Valentin Emiya, Caroline +Chaux and Bruno Torré́sani, 2020. Install ------- @@ -16,10 +16,10 @@ Install the current release with ``pip``:: Download the data from `this link <https://gitlab.lis-lab .fr/skmad-suite/tff2020/-/tree/master/data>`. -Then run function :py:fun:`tffpy.utils.generate_config`: in order to create +Then run function :py:fun:`tffpy.utils.generate_config` in order to create a configuration file and modify it to specify the path to your data folder. The location of the configuration file is given by function -:py:fun:tffpy.utils.get_config_file():. +:py:fun:`tffpy.utils.get_config_file`. For additional details, see doc/install.rst.