Skip to content

Commit

Permalink
README tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
seanh committed Jul 6, 2022
1 parent 154e336 commit 154aef2
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions .cookiecutter/includes/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@

pip-sync-faster makes pip-sync run faster in the case where there's nothing to
do because the virtualenv is already up to date with the requirements files. On
my machine, with my requirements files, it shaves off about 500ms in the time
taken to run pip-sync:
pip-sync-faster makes
[pip-sync](https://pip-tools.readthedocs.io/en/latest/#example-usage-for-pip-sync)
run faster in the case where there's nothing to do because the virtualenv is
already up to date with the requirements files. On my machine, with my
requirements files, it shaves off over 500ms in the time taken to run pip-sync:

```terminal
$ time pip-sync requirements/foo.txt
Expand All @@ -22,7 +23,6 @@ sys 0m0.008s
pip-sync-faster does this by saving hashes of the given requirements files in a
JSON file within the virtualenv and not calling pip-sync if the hashes haven't
changed.

If any of the given requirements files doesn't have a matching cached hash then
pip-sync-faster calls pip-sync forwarding all command line arguments and
options.
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@ For installation instructions see [INSTALL.md](https://github.com/hypothesis/pip
For how to set up a pip-sync-faster development environment see
[HACKING.md](https://github.com/hypothesis/pip-sync-faster/blob/main/HACKING.md).

pip-sync-faster makes pip-sync run faster in the case where there's nothing to
do because the virtualenv is already up to date with the requirements files. On
my machine, with my requirements files, it shaves off about 500ms in the time
taken to run pip-sync:
pip-sync-faster makes
[pip-sync](https://pip-tools.readthedocs.io/en/latest/#example-usage-for-pip-sync)
run faster in the case where there's nothing to do because the virtualenv is
already up to date with the requirements files. On my machine, with my
requirements files, it shaves off over 500ms in the time taken to run pip-sync:

```terminal
$ time pip-sync requirements/foo.txt
Expand All @@ -37,7 +38,6 @@ sys 0m0.008s
pip-sync-faster does this by saving hashes of the given requirements files in a
JSON file within the virtualenv and not calling pip-sync if the hashes haven't
changed.

If any of the given requirements files doesn't have a matching cached hash then
pip-sync-faster calls pip-sync forwarding all command line arguments and
options.
Expand Down

0 comments on commit 154aef2

Please sign in to comment.