Improve README. WIP issue #972.

plone · Dec 3, 2024 · 94e3580 · 94e3580
1 parent cf92d4d
commit 94e3580
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/README-devcontainers.md b/README-devcontainers.md
@@ -0,0 +1,3 @@
+# Using devcontainers in VS Code and GitHub Codespaces
+
+TODO.
diff --git 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 <https://6.docs.plone.org/contributing/core/index.html>`_ 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 <README-make.md>`.
+
+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 <README-devcontainers.md>`.
+
+If you want to contribute to Plone in a more generic way you can read the `Contributing to Plone <https://6.docs.plone.org/contributing/index.html>` and the starting page of `Plone 6 Documentation <https://6.docs.plone.org/>`.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Using devcontainers in VS Code and GitHub Codespaces

		TODO.