Skip to content

Commit 74c0006

Browse files
committed
Introduce CLI before GUI in the README
1 parent 8bddb8b commit 74c0006

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,24 +28,6 @@ flowchart LR
2828

2929
This script was developed using Python version `3.10.5`.
3030

31-
### GUI
32-
33-
Install dependencies:
34-
35-
```shell
36-
$ python -m pip install -r requirements.txt
37-
```
38-
39-
Open the GUI:
40-
41-
```shell
42-
$ python gui.py
43-
```
44-
Here's what the GUI looks like as of version `v1.2.0`. The GUI was created as an "afterthought" to the CLI and is targeted at users who are already familiar with the CLI options, but don't want to type filesystem paths onto the command line.
45-
46-
47-
![gui](./doc/gui.png)
48-
4931
### CLI
5032
> **Note:** You can use the CLI without installing any dependencies, since all dependencies used by the CLI are included in the Python standard library.
5133
@@ -91,6 +73,26 @@ $ python main.py /path/to/folder/ ./some/dupelist.csv
9173
$ python main.py /path/to/folder/ ./some/dupelist.csv --output_csv_file /temp/nondupes.csv --log_level DEBUG
9274
```
9375
76+
### GUI
77+
78+
The GUI was created as an "afterthought" to the CLI and is targeted at users who are already familiar with the CLI options, but don't want to type filesystem paths onto the command line.
79+
80+
Install dependencies:
81+
82+
```shell
83+
$ python -m pip install -r requirements.txt
84+
```
85+
86+
Open the GUI:
87+
88+
```shell
89+
$ python gui.py
90+
```
91+
92+
Here's what the GUI looks like as of release `v1.2.1`:
93+
94+
![gui](./doc/gui.png)
95+
9496
# Testing
9597
9698
Run the unit tests:

0 commit comments

Comments
 (0)