README: examples and thoughts
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
This commit is contained in:
parent
1071567f8d
commit
5c9fd8cbda
1 changed files with 23 additions and 1 deletions
24
README.md
24
README.md
|
@ -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.
|
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
|
## install
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
git clone https://github.com/vbatts/terminal-url-handler
|
||||||
|
cd terminal-url-handler
|
||||||
make user-install
|
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
|
## development
|
||||||
|
|
||||||
happy to take contributions or enhancements.
|
happy to take contributions or enhancements.
|
||||||
|
|
||||||
This seems like something that ought to be built-in for most desktops.
|
This seems like something that ought to be built-in for most desktops.
|
||||||
|
|
||||||
|
|
||||||
### lint
|
### lint
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
@ -32,6 +50,10 @@ Whatever.
|
||||||
|
|
||||||
https://portland.freedesktop.org/doc/xdg-settings.html
|
https://portland.freedesktop.org/doc/xdg-settings.html
|
||||||
|
|
||||||
|
### Future improvements?
|
||||||
|
|
||||||
|
- [ ] if a `user@host` is included, then ssh to the host
|
||||||
|
|
||||||
## LICENSE
|
## LICENSE
|
||||||
|
|
||||||
See [LICENSE](./LICENSE)
|
See [LICENSE](./LICENSE)
|
||||||
|
|
Loading…
Reference in a new issue