Skip to content

Commit ba4cf13

Browse files
authored
Update README.md
1 parent 115b423 commit ba4cf13

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@
44

55
`locatorator` will display the changes on-screen, as well as output a new marker list that can be imported into the new sequence to call out changes.
66

7-
Updated documentation coming soon.
7+
## Installation
8+
Gently clone this repo, then install:
9+
10+
```bash
11+
pip3 install .
12+
```
13+
14+
## Usage
15+
Once installed, two commands will be available to you:
16+
17+
*`locatorator` - The GUI-based program
18+
*`locatorator_cli` - The command-line version of the program
819

920
![Locatorator on Mac OS X](docs/locatorator_osx.png)

0 commit comments

Comments
 (0)