Merge pull request ARM-Development#58 from zssherman/readme_update

DOC: Update readme to be rst.

README.rst

@@ -0,0 +1,49 @@
+===========================================
+Radar Tracking of Quality Toolkit (RadTraQ)
+===========================================
+
+|Build| |Docs|
+
+.. |Docs| image:: https://github.com/ARM-Development/RadTraQ/actions/workflows/documentation.yml/badge.svg
+    :target: https://github.com/ARM-Development/RadTraQ/actions/workflows/documentation.yml
+
+.. |Build| image:: https://github.com/ARM-Development/RadTraQ/actions/workflows/pythonpackage.yml/badge.svg
+    :target: https://github.com/ARM-Development/RadTraQ/actions/workflows/pythonpackage.yml
+
+RadTraQ is a python library housing routines related to assessing and monitoring
+the quality of a radar's quality and calibration. This library is a work in progress,
+currently housing scipts to plot radar CFADs, plot and analyze corner reflector
+scans, calculate noise floors, create cloud masks, and plot up average profiles
+for comparisons.
+
+Check out the `documentation <https://arm-development.github.io/RadTraQ/build/html/index.html>`_
+and `example gallery <https://arm-development.github.io/RadTraQ/build/html/source/auto_examples/index.html>`_ for more details.
+
+Papers that these routines are based on will be listed in the documentation for
+each relevant function.
+
+|Reflector| |CloudMask| |VPT|
+
+.. |Reflector| image:: https://arm-development.github.io/RadTraQ/build/html/_images/sphx_glr_plot_corner_reflector_raster_001.png
+               :target: https://arm-development.github.io/RadTraQ/build/html/_images/sphx_glr_plot_corner_reflector_raster_001.png
+               :height: 150
+.. |CloudMask| image:: https://arm-development.github.io/RadTraQ/build/html/_images/sphx_glr_plot_cloud_mask_001.png
+               :target: https://arm-development.github.io/RadTraQ/build/html/_images/sphx_glr_plot_cloud_mask_001.png
+               :height: 150
+.. |VPT| image:: https://arm-development.github.io/RadTraQ/build/html/_images/sphx_glr_plot_mask_vpt_001.png
+         :target: https://arm-development.github.io/RadTraQ/build/html/_images/sphx_glr_plot_mask_vpt_001.png
+         :height: 150
+
+Installation
+~~~~~~~~~~~~
+
+RadTraQ is installable using pip::
+
+    pip install radtraq
+
+Contributing
+~~~~~~~~~~~~
+
+We welcome contributions for all uses of RadTraQ, provided the code can be
+distributed under the BSD 3-clause license. A copy of this license is
+available in the **LICENSE** file in this directory.

setup.py

@@ -15,7 +15,7 @@
 
 here = path.abspath(path.dirname(__file__))
 
-with open(path.join(here, 'README.md'), encoding='utf-8') as readme_file:
+with open(path.join(here, 'README.rst'), encoding='utf-8') as readme_file:
     readme = readme_file.read()
 
 with open(path.join(here, 'requirements.txt')) as requirements_file: