From c6a39d8209ef0f993f161384319f229d03625c7e Mon Sep 17 00:00:00 2001 From: Steph Samson Date: Thu, 9 Oct 2014 17:32:31 -0400 Subject: [PATCH] Rewrite configuration doc to be a bit clearer. --- doc/sphinx/source/configuration.rst | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/doc/sphinx/source/configuration.rst b/doc/sphinx/source/configuration.rst index e45ee206f..8a570e0de 100644 --- a/doc/sphinx/source/configuration.rst +++ b/doc/sphinx/source/configuration.rst @@ -2,14 +2,12 @@ Configuration ============= -You can copy the supplied sample-config to your home directory and move it to -``$XDG_CONFIG_HOME/bpython/config`` [#f1]_. bpython tries to find -``$XDG_CONFIG_HOME/bpython/config`` and use it as its configuration, if the -file does not exist bpython will use its documented defaults. +There is a ``sample-config`` file supplied in your home directory. You can rename it +to ``config`` or copy it and make a new ``config`` file since bpython tries to +find ``$XDG_CONFIG_HOME/bpython/config``(``$XDG_CONFIG_HOME`` defaults to ``~/.config`` if not set) +and use it as its configuration. -.. :: Footnotes - -.. [#f1] ``$XDG_CONFIG_HOME`` defaults to ``~/.config`` if not set. +To edit the config file from ``bpython-curtsies``, press ``F3``. .. include:: configuration-options.rst