From ba8512e70d83724f6a79ac29a65c015117425504 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20S=C3=A1nchez-Gallego?= Date: Mon, 13 Apr 2020 22:55:37 -0700 Subject: [PATCH] Add warning about v2 --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 95f646d..cdf2f8e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # cookiecutter-python +> :warning: Version 1 of the template is now deprecated. You probably want [v2](https://github.com/sdss/python_template). + + This is a [cookiecutter](https://github.com/audreyr/cookiecutter) template for creating Python packages that adhere to the [SDSS standard](./\{\{cookiecutter.repo_name\}\}/STYLE.rst). The full documentation on how to use this template can be found [here](http://sdss-python-template.readthedocs.io/en/latest/). @@ -11,7 +14,7 @@ To install and initialize this template: pip install invoke pip install bumpversion pip install cookiecutter - cookiecutter https://github.com/sdss/python_template.git + cookiecutter https://github.com/sdss/python_template.git --checkout python-template-v1 or to optionally install a specific branch: @@ -23,7 +26,6 @@ During the installation, you will be asked a series of prompts to specify option * do you want to create a git repository out of your new package? * do you want to connect your new git repo to an account on github? - ## Developers If you are developing on this template, first clone the product: