Skip to content

Commit 4e2d9e0

Browse files
committed
README improvements
1 parent 1b4136c commit 4e2d9e0

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![Build Status](https://travis-ci.com/note/teleport-scala.svg?branch=master)](https://travis-ci.org/note/teleport-scala)
1+
[![Build Status](https://travis-ci.com/note/teleport-scala.svg?branch=master)](https://travis-ci.com/note/teleport-scala)
22
[![GitHub release](https://img.shields.io/github/v/release/note/teleport-scala.svg)](https://github.com/note/teleport-scala/releases/)
33

44
# teleport-scala
@@ -25,7 +25,7 @@ you can:
2525

2626
As a result `teleport-scala.jar` and executable `teleport-scala` should be created.
2727

28-
## Bring `tp` into scope
28+
## Bringing `tp` into scope
2929

3030
If you watched the asciiname animation you may have noticed that it uses `tp` command as opposed to `teleport-scala`.
3131
T bring `tp` into scope add the following to your `.zshrc`/`.bashrc`:
@@ -34,7 +34,9 @@ T bring `tp` into scope add the following to your `.zshrc`/`.bashrc`:
3434
source /your/path/to/teleport-scala/teleport.sh
3535
```
3636

37-
### For curious - what's the point of having `teleport-scala` and `tp`?
37+
It's crucial that executable `teleport-scala` is in the same directory as `teleport.sh` (which is the case by default after running `./build.sh`).
38+
39+
### For curious - what's the point of having `tp` in addition to `teleport-scala`?
3840

3941
The problem is that `goto` command cannot be fully implemented in a subprocess; it's not possible for the
4042
`teleport-scala` to change working directory of the caller process. Therefore, `teleport-scala goto point` returns

0 commit comments

Comments
 (0)