Skip to content

Commit 154aef2

Browse files
committed
README tweaks
1 parent 154e336 commit 154aef2

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

.cookiecutter/includes/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11

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

78
```terminal
89
$ time pip-sync requirements/foo.txt
@@ -22,7 +23,6 @@ sys 0m0.008s
2223
pip-sync-faster does this by saving hashes of the given requirements files in a
2324
JSON file within the virtualenv and not calling pip-sync if the hashes haven't
2425
changed.
25-
2626
If any of the given requirements files doesn't have a matching cached hash then
2727
pip-sync-faster calls pip-sync forwarding all command line arguments and
2828
options.

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,11 @@ For installation instructions see [INSTALL.md](https://github.com/hypothesis/pip
1414
For how to set up a pip-sync-faster development environment see
1515
[HACKING.md](https://github.com/hypothesis/pip-sync-faster/blob/main/HACKING.md).
1616

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

2223
```terminal
2324
$ time pip-sync requirements/foo.txt
@@ -37,7 +38,6 @@ sys 0m0.008s
3738
pip-sync-faster does this by saving hashes of the given requirements files in a
3839
JSON file within the virtualenv and not calling pip-sync if the hashes haven't
3940
changed.
40-
4141
If any of the given requirements files doesn't have a matching cached hash then
4242
pip-sync-faster calls pip-sync forwarding all command line arguments and
4343
options.

0 commit comments

Comments
 (0)