diff options
| author | Adam Kocoloski <kocolosk@apache.org> | 2021-01-18 13:21:37 -0500 |
|---|---|---|
| committer | Adam Kocoloski <kocolosk@apache.org> | 2021-01-18 13:26:49 -0500 |
| commit | 7974dad0ce28ddd6b78b6648869a03411cc19e6a (patch) | |
| tree | 0e8dfa2d1c661d180a5127e8641bf18103c6d177 | |
| parent | 2859d26748041978eac966e0325753681d74ef2e (diff) | |
| download | couchdb-7974dad0ce28ddd6b78b6648869a03411cc19e6a.tar.gz | |
Make a note in README-DEV about the existence of devcontainer
Also a drive-by fix to note that Elixir is now required.
| -rw-r--r-- | README-DEV.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/README-DEV.rst b/README-DEV.rst index f4031b767..c8a52ffd4 100644 --- a/README-DEV.rst +++ b/README-DEV.rst @@ -15,6 +15,7 @@ Dependencies You need the following to run tests: * `Python 3 <https://www.python.org/>`_ +* `Elixir <https://elixir-lang.org/>`_ You need the following optionally to build documentation: @@ -51,6 +52,18 @@ sufficient to enable a Fauxton build. Here is a list of *optional* dependencies for various operating systems. Installation will be easiest, when you install them all. +Docker +~~~~~~ + +CouchDB maintains a ``Dockerfile`` based on Debian that includes all +the dependencies noted above in the `.devcontainer <https://github.com/apache/couchdb/tree/main/.devcontainer>`_ +folder. + +The ``Dockerfile`` can be used on its own, or together with the +associated ``devcontainer.json`` file to quickly provision a +development environment using `GitHub Codespaces <https://github.com/features/codespaces>`_ +or `Visual Studio Code <https://code.visualstudio.com/docs/remote/containers>`_. + Debian-based (inc. Ubuntu) Systems ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
