Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork939
Commit72e48aa
committed
Update installation instructions in readme
This changes the installation instructions in README.md torecommend "pip install ." instead of "python setup.py install". Theformer is compatible with Python 3.12 which doesn't have setuptoolsinstalled by default (so setup.py, which imports it, can beindirectly but not directly used). This also matches thecorresponding change made in the installation unit test.While doing so, I've also clarified the instructions, and added theimplied "cd" command as well as the "git fetch --tags" command inthe position where a later section was recently updated to mentionit should have been run.Using "pip install ." creates the opportunity to pass "-e" to makean editable install, which users who clone the repository to workon changes should do, because the effect of an editable install isonly partially simulated by pytest, and so that manual testing ofchanges actually uses the changes intended for testing.This increases the length and detail of the instructions, so I'veadded h4 subsections to clarify the separations between them andmake it easier for readers to find the part they're looking for. Indoing so, I've reordered these subsections accordingly. Becausegreater detail can create the impression that all important stepsare mentioned, I've made the general good advice to use a virtualenvironment explicit. For brevity, I have not added venv commands.1 parentdba4245 commit72e48aa
1 file changed
+28
-9
lines changedLines changed: 28 additions & 9 deletions
Original file line number | Diff line number | Diff line change | |
---|---|---|---|
| |||
49 | 49 |
| |
50 | 50 |
| |
51 | 51 |
| |
52 |
| - | |
| 52 | + | |
53 | 53 |
| |
54 |
| - | |
55 |
| - | |
56 |
| - | |
| 54 | + | |
57 | 55 |
| |
58 |
| - | |
| 56 | + | |
59 | 57 |
| |
60 | 58 |
| |
61 | 59 |
| |
62 | 60 |
| |
63 | 61 |
| |
64 |
| - | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
65 | 67 |
| |
66 |
| - | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
67 | 71 |
| |
68 |
| - | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
69 | 75 |
| |
70 | 76 |
| |
71 | 77 |
| |
72 |
| - | |
| 78 | + | |
| 79 | + | |
73 | 80 |
| |
74 | 81 |
| |
75 | 82 |
| |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
76 | 95 |
| |
77 | 96 |
| |
78 | 97 |
| |
|
0 commit comments
Comments
(0)