Add README

Author: wdv4758h

README.rst

@@ -0,0 +1,77 @@
+========================================
+python-everywhere
+========================================
+
+Inspired by `rust-everywhere <https://github.com/japaric/rust-everywhere>`_.
+
+
+Installation
+========================================
+
+.. code-block:: sh
+
+    python setup.py install
+
+
+
+Testing
+========================================
+
+pytest
+------------------------------
+
+With `pytest-runner <https://github.com/pytest-dev/pytest-runner>`_,
+we will have ``python setup.py pytest``.
+
+With ``addopts = --doctest-modules`` in ``pytest.ini``,
+we will also invoke doctest.
+
+With alias in ``setup.cfg``, we can just use ``python setup.py test``.
+
+run your test code :
+
+.. code-block:: sh
+
+    python setup.py test
+    python setup.py test --addopts -v   # verbose
+
+
+Here is the pytest's `documetation <https://pytest.org/latest/goodpractices.html#integrating-with-setuptools-python-setup-py-test-pytest-runner>`_ about integrating with setuptools.
+
+
+
+Linter
+========================================
+
+Flake8
+------------------------------
+
+.. code-block:: sh
+
+    python setup.py flake8
+
+
+Here is the flake8's `documetation <http://flake8.readthedocs.io/en/latest/setuptools.html>`_ about integrating with setuptools.
+
+
+
+Type Checking
+========================================
+
+mypy
+------------------------------
+
+.. code-block:: sh
+
+    mypy everywhere
+
+
+
+Continuous Integration
+========================================
+
+Travis CI
+------------------------------
+
+Please visit ``https://travis-ci.org/profile/USERNAME``
+to open Travis CI support for your repo.