Fixing some typos in the README and removing the section about creati…

…ng a virtualenv, which is outside the scope of the README.
jdavidheiser · Mar 7, 2016 · 7013953 · 7013953
1 parent 4533b73
commit 7013953
Showing 1 changed file with 5 additions and 36 deletions.
diff --git a/README.rst b/README.rst
@@ -5,7 +5,7 @@ Qgrid is an IPython widget which uses `SlickGrid <https://github.com/mleibman/Sl
 within a Jupyter notebook. This allows you to explore your DataFrames with intuitive scrolling, sorting, and
 filtering controls, **as well as edit your DataFrames by double clicking a cell (new in v0.3.0)**.
 
-We originally developed qgrid it for use in `Quantopian's hosted research environment
+We originally developed qgrid for use in `Quantopian's hosted research environment
 <https://www.quantopian.com/research?utm_source=github&utm_medium=web&utm_campaign=qgrid-repo>`_, but no longer have
 a specific project in mind for using qgrid in the research environment.  For that reason we haven't been investing
 much time in developing new features, and almost all of the forward development has come from the community. We've
@@ -71,14 +71,13 @@ The qgrid repository includes a demo notebook which will help you get familiar w
 provides.  This demo notebook doesn't get downloaded to your machine when you install qgrid with pip, so you'll need
 to clone the qgrid repository to get it.  Here are the steps to clone the repository and run the demo notebook:
 
-#. Clone the repository from GitHub and ``cd`` into it the top-level directory::
+#. Clone the repository from GitHub::
 
     git clone https://github.com/quantopian/qgrid.git
-    cd qgrid
 
 #. Go to the top-level directory of the qgrid repository and run the notebook::
 
-    cd ~/qgrid
+    cd qgrid
     jupyter notebook
 
    The advantage of running the notebook from the top-level directoy of the qgrid repository is the sample notebook
@@ -90,8 +89,7 @@ to clone the qgrid repository to get it.  Here are the steps to clone the reposi
          :target: docs/images/home_screen.png
          :width: 800px
 
-         The "notebook dashboard" for the jupyter notebook which shows all the files in the current directory.  Notice
-         the demo notebook which is qgrid_demo.ipynb.
+         The "notebook dashboard" for the jupyter notebook which shows all the files in the current directory.
 
 #. Click on qgrid_demo.ipynb to open it.  Here's what that should like:
 
@@ -120,7 +118,7 @@ If you'd like to contribute to qgrid, or just want to be able to modify the sour
 want to clone this repository and run qgrid from your local copy of the repository.  The following steps explain how
 to do this.
 
-#. Clone the repository from GitHub and ``cd`` into it the top-level directory::
+#. Clone the repository from GitHub and ``cd`` into the top-level directory::
 
     git clone https://github.com/quantopian/qgrid.git
     cd qgrid
@@ -143,32 +141,3 @@ to do this.
    `nb_install <http://qgrid.readthedocs.org/en/latest/#qgrid.nbinstall>`_ function from within the notebook to copy
    your latest changes to the "nbextensions" folder (i.e. where widgets must put their javascript for it to be found
    by the notebook).
-
-Setting up your virtualenv
---------------------------
-
-Using virtualenv is the recommended way of keeping Python dependencies for various project isolated.  The following
-step help you set up a virtualenv for qgrid (which I'm sure most of you know how to do already).
-
-Before you proceed with this section you'll need
-`virtualenv and virtualenvwrapper <https://virtualenv.readthedocs.org/en/latest/>`_.  Install them like this::
-
-    pip install virtualenv
-    pip install virtualenvwrapper
-
-#. Create a virtualenv for Jupyter notebook and qgrid::
-
-    mkvirtualenv qgrid # create virtualenv called qgrid, and use Python 2 inside that virtualenv
-
-   This will work but on my machine the resulting virtualenv will use whatever version of python comes up when you run
-   ``python --version``, which in my case is Python 2.  If you want to use Python 3, specify the path to the version of
-   Python you want to use, which for me looks like this::
-
-    mkvirtualenv --python=/usr/local/bin/python3 qgrid # create virtualenv called qgrid, and use Python 3 inside that virtualenv
-
-   You may have to change the ``/usr/local/bin/python3`` path depending on how you installed Python 3.  If you're unsure,
-   type ``which python3`` to get the path to your Python 3 installation.
-
-#. Install qgrid::
-
-    pip install qgrid # see the "Installation" section above for more options