Skip to content

Commit ac6850d

Browse files
authored
Update README.md
1 parent 2016df4 commit ac6850d

File tree

1 file changed

+11
-15
lines changed

1 file changed

+11
-15
lines changed

README.md

+11-15
Original file line numberDiff line numberDiff line change
@@ -61,16 +61,21 @@ python -m venv venv
6161
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
6262
```
6363

64-
3. Install the required dependencies:
64+
3. Install tkreload (in editable mode):
6565
```sh
66-
pip install -r requirements.txt
66+
pip install -e.[test]
6767
```
6868

69-
4. Install tkreload:
70-
```sh
71-
pip install .
69+
# Usage
70+
71+
To run the app with `tkreload`, use the following command in your terminal:
72+
73+
```bash
74+
tkreload your_app.py
7275
```
7376

77+
Now, whenever you save changes to your script, tkreload will automatically reload your application.
78+
7479
## 🌟 Features
7580

7681
- **Automatic Reloading:** Automatically restarts Tkinter apps upon file changes.
@@ -82,15 +87,6 @@ pip install .
8287
- **Real-Time Feedback:** Uses `rich` for styled console feedback and progress indicators.
8388

8489

85-
# Usage
86-
87-
To run the app with `tkreload`, use the following command in your terminal:
88-
89-
```bash
90-
tkreload your_app.py
91-
```
92-
93-
Now, whenever you save changes to your script, tkreload will automatically reload your application.
9490

9591
## Testing
9692
To verify tkreload functionality, follow these steps:
@@ -99,7 +95,7 @@ To verify tkreload functionality, follow these steps:
9995

10096
2.Run Tests Using Pytest
10197
```bash
102-
pytest .
98+
pytest -v
10399
```
104100
This will run the test suite and confirm tkreload is working as expected.
105101

0 commit comments

Comments
 (0)