X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/24418a54501381e1cdbe0ab1de4e4ced7537c124..48dfda084a8c854a73c11b6c91c67deae5f86ca3:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 411a8c8..b19e6e5 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,8 @@ _Contents:_ **[Installation and usage](#installation-and-usage)** | ### Installation _Black_ can be installed by running `pip install black`. It requires Python 3.6.2+ to -run but you can reformat Python 2 code with it, too. +run. If you want to format Python 2 code as well, install with +`pip install black[python2]`. #### Install from GitHub @@ -292,6 +293,20 @@ parent directories. It stops looking when it finds the file, or a `.git` directo If you're formatting standard input, _Black_ will look for configuration starting from the current working directory. +You can use a "global" configuration, stored in a specific location in your home +directory. This will be used as a fallback configuration, that is, it will be used if +and only if _Black_ doesn't find any configuration as mentioned above. Depending on your +operating system, this configuration file should be stored as: + +- Windows: `~\.black` +- Unix-like (Linux, MacOS, etc.): `$XDG_CONFIG_HOME/black` (`~/.config/black` if the + `XDG_CONFIG_HOME` environment variable is not set) + +Note that these are paths to the TOML file itself (meaning that they shouldn't be named +as `pyproject.toml`), not directories where you store the configuration. Here, `~` +refers to the path to your home directory. On Windows, this will be something like +`C:\\Users\UserName`. + You can also explicitly specify the path to a particular file that you want with `--config`. In this situation _Black_ will not look for any other file.