Skip to content

Commit 7e7d636

Browse files
committed
Tidy up
1 parent 49079f6 commit 7e7d636

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
11
# Shortlister
22

3-
Light-weight program that assists with shortlisting candidates in a management setting.
3+
Lightweight program for shortlisting candidates.
4+
5+
## Installation
6+
7+
```bash
8+
pip install "git+https://github.com/UCL-ARC/shortlister"
9+
```
10+
11+
If you want to use the PDF window feature, you will need to install the following dependencies:
12+
13+
```bash
14+
pip install pywebview flask
15+
```
416

517
## Quick start
618

7-
Run the following script from terminal:
19+
Run the following command in your terminal:
820

921
```bash
1022
shortlist <role_directory>
@@ -29,6 +41,7 @@ shortlist <role_directory> -w
2941
- Alphabetical
3042
- Score (Ascending/Descending)
3143
- Interactive comparison sort
44+
3245
#### Filtering
3346
- allow users to enter their own expressions
3447
- up/down arrow keys for filtering templates
@@ -37,12 +50,16 @@ shortlist <role_directory> -w
3750
#### Mark applicant
3851
- select a criterion and give an appropiate score
3952
- create notes on selected applicant
53+
4054
#### Ranking
4155
- Quickly compare a list of applicant
56+
4257
#### Export excel spreadsheet
4358
- Export the applicant table to an Excel spreadsheet
59+
4460
#### PDF Webview
4561
- Open pdfs automatically in webview if viewing details for a specific applicant
62+
4663
#### REPL:
4764
- Open a Python REPL within the terminal
4865
- Developer mode (full control to the program)

0 commit comments

Comments
 (0)