README: examples and thoughts

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
This commit is contained in:
Vincent Batts 2024-05-23 22:33:48 -04:00
parent 1071567f8d
commit 5c9fd8cbda
Signed by: vbatts
GPG key ID: E30EFAA812C6E5ED

View file

@ -4,19 +4,37 @@
It would be great to put a link in my notes to the directory I working in on a project, and it opens a terminal right to there.
Something simple like a [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) to the directory you had a terminal open.
## install
```shell
git clone https://github.com/vbatts/terminal-url-handler
cd terminal-url-handler
make user-install
```
## examples
Say you keep a notebook/journal/whatever in an app that allows hyperlinks (markdown, html, etc.).
Create a link:
```markdown
[terminal-url-handler](terminal://~/src/terminal-url-handler)
```
i.e. [terminal-url-handler](terminal://~/src/terminal-url-handler)
```html
<a href="terminal://~/src/terminal-url-handler">terminal-url-handler</a>
```
## development
happy to take contributions or enhancements.
This seems like something that ought to be built-in for most desktops.
### lint
```shell
@ -32,6 +50,10 @@ Whatever.
https://portland.freedesktop.org/doc/xdg-settings.html
### Future improvements?
- [ ] if a `user@host` is included, then ssh to the host
## LICENSE
See [LICENSE](./LICENSE)