Skip to content

Commit

Permalink
Introduce CLI before GUI in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
gitname committed Jul 30, 2022
1 parent 8bddb8b commit 74c0006
Showing 1 changed file with 20 additions and 18 deletions.
38 changes: 20 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,24 +28,6 @@ flowchart LR

This script was developed using Python version `3.10.5`.

### GUI

Install dependencies:

```shell
$ python -m pip install -r requirements.txt
```

Open the GUI:

```shell
$ python gui.py
```
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.


![gui](./doc/gui.png)

### CLI
> **Note:** You can use the CLI without installing any dependencies, since all dependencies used by the CLI are included in the Python standard library.
Expand Down Expand Up @@ -91,6 +73,26 @@ $ python main.py /path/to/folder/ ./some/dupelist.csv
$ python main.py /path/to/folder/ ./some/dupelist.csv --output_csv_file /temp/nondupes.csv --log_level DEBUG
```
### GUI
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.
Install dependencies:
```shell
$ python -m pip install -r requirements.txt
```
Open the GUI:
```shell
$ python gui.py
```
Here's what the GUI looks like as of release `v1.2.1`:
![gui](./doc/gui.png)
# Testing
Run the unit tests:
Expand Down

0 comments on commit 74c0006

Please sign in to comment.