From f2e5dcf02a15c7ddb6a2e7d3a735cc9a71111ab4 Mon Sep 17 00:00:00 2001 From: Erik Tollerud Date: Thu, 3 Feb 2022 16:45:48 -0500 Subject: [PATCH] add README note aobut OA guide --- README.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.rst b/README.rst index b0b27c0c..5c022e83 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,19 @@ Astropy package template |powered| - **cookiecutter branch:** |ci cookiecutter| +Pending Deprecation Warning +--------------------------- +This template is in the process of being subsumed by the +`OpenAstronomy packaging guide `__, +which reflects more up-to-date Python packaging techniques than this template. In +the future this template will be replaced by a guide built from the OA guide specific +to Astropy, but in the mine time, if you are starting a new project you may wish to +start from the OA guide. + + +Introduction +------------ + This is a package template provided by the Astropy project. Using this template, packages can make use of the setup, installation, and documentation