Skip to content
This repository has been archived by the owner on Aug 11, 2023. It is now read-only.

Commit

Permalink
Merge pull request #239 from Cadair/readme
Browse files Browse the repository at this point in the history
Add info in README
  • Loading branch information
bsipocz committed May 11, 2017
2 parents 3e995fa + 7617a21 commit d82c180
Showing 1 changed file with 26 additions and 9 deletions.
35 changes: 26 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,32 @@ Such packages can make use of the setup, installation, and documentation
infrastructure developed for the ``astropy`` core package simply by
using this template to lay out the package.

For more information, see:
Using this package
------------------

* `Detailed instructions for using this template <http://docs.astropy.org/en/latest/development/affiliated-packages.html>`_
* `The Affiliated Packages section of the Astropy web site <http://affiliated.astropy.org>`_
* `This template's Github code repository <https://github.com/astropy/package-template>`_
This package makes use of the `cookiecutter
<https://cookiecutter.readthedocs.io/en/latest/index.html>`__ package to make it
easier to get started with the package template. You will need to `install cookiecutter <https://cookiecutter.readthedocs.io/en/latest/installation.html>`__ which can
be done easily using conda or pip::

Status reports for developers
-----------------------------
conda install cookiecutter

.. image:: https://travis-ci.org/astropy/package-template.svg
:target: https://travis-ci.org/astropy/package-template
:alt: Travis Status
pip install cookiecutter

Once you have cookiecutter installed you can run::

cookiecutter gh:astropy/package-template


Which will ask you a series of questions to configure your package. For more information you can see the `package template documentation <>`__.


Improving the package template
------------------------------

If you want to modify this package to add or fix things, the actual folder that
the user ends up with is the ``{{ cookiecutter.package_name }}`` folder in this
repository. Everything in the repository that is not in this folder is not part
of the template that the user will have rendered.

For further information on writing templates for cookiecutter see `the docs <https://cookiecutter.readthedocs.io/en/latest/first_steps.html>`__

0 comments on commit d82c180

Please sign in to comment.