From 16ca118650123ee4962e0be99a223ea4a9dde529 Mon Sep 17 00:00:00 2001 From: "valentin.emiya" <valentin.emiya@lif.univ-mrs.fr> Date: Thu, 4 Jun 2020 16:39:57 +0200 Subject: [PATCH] update doc --- python/README.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/python/README.rst b/python/README.rst index 52bdfa3..b3abd27 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. -- GitLab