From e9c5a7edd6a8c3862be2cbdf28a60d8357bad865 Mon Sep 17 00:00:00 2001 From: mgrover1 Date: Thu, 24 Aug 2023 21:42:16 -0500 Subject: [PATCH] DEL: Remove the old readme --- README.rst | 56 ------------------------------------------------------ 1 file changed, 56 deletions(-) delete mode 100644 README.rst diff --git a/README.rst b/README.rst deleted file mode 100644 index 33d462f..0000000 --- a/README.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. image:: https://github.com/openradar/cmweather/actions/workflows/ci.yaml/badge.svg - :target: https://github.com/openradar/cmweather/actions/workflows/ci.yaml - :alt: Continuous Integration Status - -.. image:: https://github.com/openradar/cmweather/actions/workflows/linting.yaml/badge.svg - :target: https://github.com/openradar/cmweather/actions/workflows/linting.yaml - :alt: Code Style Status - -.. image:: https://img.shields.io/codecov/c/github/openradar/cmweather.svg?style=for-the-badge - :target: https://codecov.io/gh/openradar/cmweather - -.. If you want the following badges to be visible, please remove this line, and unindent the lines below - .. image:: https://img.shields.io/readthedocs/cmweather/latest.svg?style=for-the-badge - :target: https://cmweather.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status - - .. image:: https://img.shields.io/pypi/v/cmweather.svg?style=for-the-badge - :target: https://pypi.org/project/cmweather - :alt: Python Package Index - - .. image:: https://img.shields.io/conda/vn/conda-forge/cmweather.svg?style=for-the-badge - :target: https://anaconda.org/conda-forge/cmweather - :alt: Conda Version - - -cmweather -========= - -Development ------------- - -For a development install, do the following in the repository directory: - -.. code-block:: bash - - conda env update -f ci/environment.yml - conda activate cmweather-dev - python -m pip install -e . - -Also, please install `pre-commit` hooks from the root directory of the created project by running:: - - pre-commit install - -These code style pre-commit hooks (black, isort, flake8, ...) will run every time you are about to commit code. - -.. If you want the following badges to be visible, please remove this line, and unindent the lines below - Re-create notebooks with Pangeo Binder - -------------------------------------- - - Try notebooks hosted in this repo on Pangeo Binder. Note that the session is ephemeral. - Your home directory will not persist, so remember to download your notebooks if you - made changes that you need to use at a later time! - - .. image:: https://img.shields.io/static/v1.svg?logo=Jupyter&label=Pangeo+Binder&message=GCE+us-central1&color=blue&style=for-the-badge - :target: https://binder.pangeo.io/v2/gh/openradar/cmweather/master?urlpath=lab - :alt: Binder