Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
art-solopov authored Feb 1, 2022
1 parent a5fcc70 commit 3324c13
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,27 @@
# tmux-launcher
Tmux launcher app written in mruby
Tmux launcher app written in mruby (yes, it needs a much better name).

# Usage

In order to use the app, you need a Yaml file named `tmux-launcher.yaml` in
your home directory. The file should look like this:

```yaml
session_name:
path: session_path # Should be a full path
options:
key_1: value_1
key_2: value_2
# ...
```

Then, when you run `tmux-launcher session_name`, it'll create a new tmux session called
`session_name` in the path `session_path` with options as declared in the config file.

# Support

It should run on any Unix-like system that supports mruby, understands `fork`, `execvp`, `execlp` and `pipe`.

# Contributing

Contributions welcome! Just don't be an ass to other contributors.

0 comments on commit 3324c13

Please sign in to comment.