Commits

Doug Hellmann committed 8d5862f

add documentation about temp files

Comments (0)

Files changed (2)

 <http://mathematism.com/2009/jul/30/presentation-pip-and-virtualenv/>`__
 showing off the features of virtualenvwrapper.
 
-===========
-Quick Setup
-===========
+============
+Installation
+============
 
-1. Create a directory to hold all of the virtual environments. The default is
-   ``$HOME/.virtualenvs``.
-
-2. Add two lines to your shell startup file (``.bashrc``,
-   ``.profile``, etc.) to set the location where the virtual
-   environments should live and the location of the script installed
-   with this package::
-
-    export WORKON_HOME=$HOME/.virtualenvs
-    source /usr/local/bin/virtualenvwrapper.sh
-
-3. Reload the startup file (e.g., run: ``source ~/.bashrc``).
-4. Run: ``workon``
-5. A list of environments, empty, is printed.
-6. Run: ``mkvirtualenv temp``
-7. A new environment, ``temp`` is created and activated.
-8. Run: ``workon``
-9. This time, the ``temp`` environment is included.
+See the `project documentation
+<http://www.doughellmann.com/docs/virtualenvwrapper/>`__ for
+installation and setup instructions.
 
 Upgrading from 1.x
 ==================

docs/source/index.rst

 6. Plugin system for more creating sharable extensions (see
    :ref:`plugins`).
 
-===========
-Quick Setup
+============
+Installation
+============
+
+WORKON_HOME
 ===========
 
-1. Create a directory to hold all of the virtual environments. The default is
-   ``$HOME/.virtualenvs``.
+The variable ``WORKON_HOME`` tells virtualenvwrapper where to place
+your virtual environments.  The default is ``$HOME/.virtualenvs``.
+This directory must be created before using any virtualenvwrapper
+commands.
 
-2. Add two lines to your shell startup file (``.bashrc``,
-   ``.profile``, etc.) to set the location where the virtual
-   environments should live and the location of the script installed
-   with this package::
+Shell Startup File
+==================
+
+Add two lines to your shell startup file (``.bashrc``, ``.profile``,
+etc.) to set the location where the virtual environments should live
+and the location of the script installed with this package::
 
     export WORKON_HOME=$HOME/.virtualenvs
     source /usr/local/bin/virtualenvwrapper.sh
 
-3. Reload the startup file (e.g., run: ``source ~/.bashrc``).
-4. Run: ``workon``
-5. A list of environments, empty, is printed.
-6. Run: ``mkvirtualenv temp``
-7. A new environment, ``temp`` is created and activated.
-8. Run: ``workon``
-9. This time, the ``temp`` environment is included.
+After editing it, reload the startup file (e.g., run: ``source
+~/.bashrc``).
+
+Quick-Start
+===========
+
+1. Run: ``workon``
+2. A list of environments, empty, is printed.
+3. Run: ``mkvirtualenv temp``
+4. A new environment, ``temp`` is created and activated.
+5. Run: ``workon``
+6. This time, the ``temp`` environment is included.
+
+Temporary Files
+===============
+
+virtualenvwrapper creates temporary files in ``$TMPDIR``.  If the
+variable is not set, it uses ``/tmp``.  To change the location of
+temporary files just for virtualenvwrapper, set
+``VIRTUALENVWRAPPER_TMPDIR``.
 
 Upgrading from 1.x
 ==================