Skip to content

Commit

Permalink
Merge pull request #609 from vphilippon/pip-sync-only-compiled-reqs
Browse files Browse the repository at this point in the history
Document that pip-sync should only be used with compiled requirements.txt
  • Loading branch information
vphilippon authored Nov 23, 2017
2 parents bef5d3b + 3336fd6 commit 3bddc0f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -171,14 +171,16 @@ generated at the top of requirements files by setting the
markupsafe==0.23 # via jinja2
werkzeug==0.10.4 # via flask
Example usage for `pip-sync`
============================
Example usage for ``pip-sync``
==============================

Now that you have a ``requirements.txt``, you can use ``pip-sync`` to update
your virtual env to reflect exactly what's in there. Note: this will
install/upgrade/uninstall everything necessary to match the ``requirements.txt``
contents.

*Be careful: pip-sync is meant to be used only with a pip-compile'd requirements.txt.*

.. code-block:: bash
$ pip-sync
Expand Down

0 comments on commit 3bddc0f

Please sign in to comment.