Skip to content

Commit a3a8c99

Browse files
authored
Update README.md
1 parent f9479fc commit a3a8c99

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ Light-weight program that assists with shortlisting candidates in a management s
44

55
## Quick start
66

7-
Run the following script from command line:
7+
Run the following script from terminal:
88

99
```bash
10-
python shortlister/main.py <role_directory>
10+
shortlist <role_directory>
1111
# <role_directory> : the path to your folder containing both:
1212
# 1.criteria(.csv file) - see test_role folder for formatting examples
1313
# 2.candidate CVs(.pdf files)
1414
```
1515
Optional arguments avaliable which offers additional functionalities:
1616

1717
```bash
18-
python shortlister/main.py <role_directory> -w
18+
shortlist <role_directory> -w
1919
# deploys webview for pdf files
2020
```
2121

@@ -45,4 +45,4 @@ python shortlister/main.py <role_directory> -w
4545
- Open pdfs automatically in webview if viewing details for a specific applicant
4646
#### REPL:
4747
- Open a Python REPL within the terminal
48-
- Developer mode (full control to the program)
48+
- Developer mode (full control to the program)

0 commit comments

Comments
 (0)