From 3c0ceaacc21288ad1ec6b48f87ce04c2df575c5f Mon Sep 17 00:00:00 2001 From: Joseph Hamman Date: Sun, 28 Apr 2019 20:28:09 -0700 Subject: [PATCH] clarify that only one of binder and .binder can be used at once --- docs/source/usage.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 87a7d722..449af33e 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -72,14 +72,14 @@ specify the ``branch-name`` or ``commit-hash``. For example:: Where to put configuration files ================================ -``repo2docker`` will look for configuration files in either: +``repo2docker`` will look for configuration files in: * A folder named ``binder/`` in the root of the repository. * A folder named ``.binder/`` in the root of the repository. * The root directory of the repository. -If either the folder ``binder/`` or ``.binder/`` is located at the top level of -the repository, only configuration files in that folder will be considered. +`repo2docker` searches for these folders in order (``binder/``, ``.binder/``, +root). Only configuration files in the first identified folder are considered. Check the complete list of :ref:`configuration files ` supported by ``repo2docker`` to see how to configure the build process.