Skip to content

Commit

Permalink
adding binder folder text
Browse files Browse the repository at this point in the history
  • Loading branch information
choldgraf committed Dec 28, 2017
1 parent 9b67d05 commit 1f21811
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
19 changes: 19 additions & 0 deletions doc/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,25 @@ A Binder is a GitHub repository that has been outfitted with the appropriate
`build files <http://repo2docker.readthedocs.io/en/latest/samples.html>`_ so
that its content can be connected with a BinderHub instance.

Can I put my configuration files outside the root of my repository?
-------------------------------------------------------------------

Yes! If you don't want your configuration files inside of your repository
root (e.g., because you have multiple ``requirements.txt`` files), you can
also place Binder configuration files in a folder called ``binder`` that is
in the root of your repository. E.g.::

myproject/
├── binder
│   └── requirements.txt
├── environment.yml
├── myfile.py
└── requirements.txt

In this case, only the ``requirments.txt`` file inside ``binder/`` will be
used to build your environment. All other configuration files outside of the
``binder/`` folder will be ignored.

What can I do if ``mybinder.org`` does not meet my needs?
---------------------------------------------------------

Expand Down
4 changes: 4 additions & 0 deletions doc/using.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ your Binder repository should contain at least:
* One (or many) text files that specify the requirements of your code.
For a complete list, see :ref:`config-files`.

Configuration text files should be either in the **root** of your
repository, or in a folder in the root of the repository that is called
``binder``. E.g., ``myrepo/binder/requirements.txt``.

.. tip::

For a list of sample repositories for use with Binder, see the
Expand Down

0 comments on commit 1f21811

Please sign in to comment.