You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by ko...@apache.org on 2021/01/18 18:27:07 UTC

[couchdb] 01/01: Make a note in README-DEV about the existence of devcontainer

This is an automated email from the ASF dual-hosted git repository.

kocolosk pushed a commit to branch 3.x-devcontainer
in repository https://gitbox.apache.org/repos/asf/couchdb.git

commit 7974dad0ce28ddd6b78b6648869a03411cc19e6a
Author: Adam Kocoloski <ko...@apache.org>
AuthorDate: Mon Jan 18 13:21:37 2021 -0500

    Make a note in README-DEV about the existence of devcontainer
    
    Also a drive-by fix to note that Elixir is now required.
---
 README-DEV.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README-DEV.rst b/README-DEV.rst
index f4031b7..c8a52ff 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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~