From 94e358002f9b45d79bcafcf3d08504c6733a15df Mon Sep 17 00:00:00 2001 From: Ramiro Batista da Luz Date: Tue, 3 Dec 2024 16:17:57 -0300 Subject: [PATCH] Improve README. WIP issue #972. --- README-devcontainers.md | 3 +++ README.rst | 6 ++++++ 2 files changed, 9 insertions(+) create mode 100644 README-devcontainers.md diff --git a/README-devcontainers.md b/README-devcontainers.md new file mode 100644 index 0000000000..e3662f0dac --- /dev/null +++ b/README-devcontainers.md @@ -0,0 +1,3 @@ +# Using devcontainers in VS Code and GitHub Codespaces + +TODO. \ No newline at end of file diff --git a/README.rst b/README.rst index 19bd67df46..65014170f5 100644 --- a/README.rst +++ b/README.rst @@ -6,3 +6,9 @@ You are on the version 6.1 branch. If this is your first time here, please read **ALL** the instructions on `docs.plone.org `_ before getting started. It will save you time in the end, we promise! + +After the previous instructions you may want to know some of ours Makefile options to run make, take a look into `Using the Makefile in buildout.coredev `. + +We have dev containers support for VS Code and GitHub Codespaces to speed up development setup, check `Using devcontainers in VS Code and GitHub Codespaces `. + +If you want to contribute to Plone in a more generic way you can read the `Contributing to Plone ` and the starting page of `Plone 6 Documentation `.