diff --git a/README.md b/README.md new file mode 100644 index 0000000000..b78796056b --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Introduction + +This is the development buildout for Plone Core (the backend and classic UI). +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! Take your time, it worth to respect your pace. + +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 if you would like to know more about the Plone content management system go to [Plone 6 Documentation](https://6.docs.plone.org/) diff --git a/README.rst b/README.rst deleted file mode 100644 index 65014170f5..0000000000 --- a/README.rst +++ /dev/null @@ -1,14 +0,0 @@ -Introduction -============ -This is the development buildout for Plone Core (the backend and classic UI). -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 `.