tmuxification 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.md +24 -5
- data/lib/tmuxification/version.rb +1 -1
- metadata +1 -1
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# Tmuxification
|
2
2
|
|
3
|
-
Generator for tmux configurations
|
4
|
-
|
3
|
+
Generator for tmux configurations. The default template starts a tmux session
|
4
|
+
with two windows in your project root, vim is started in the first window.
|
5
5
|
|
6
6
|
## Tested on
|
7
7
|
|
@@ -14,18 +14,37 @@ containing vim in your project root.
|
|
14
14
|
|
15
15
|
## Usage
|
16
16
|
|
17
|
-
|
17
|
+
### Create a new tmux project
|
18
18
|
|
19
19
|
cd ~/code/my_project
|
20
20
|
tmuxification create
|
21
21
|
|
22
|
-
|
22
|
+
### Start the project (from any directory)
|
23
23
|
|
24
24
|
start_my_project
|
25
25
|
|
26
|
+
### Templates
|
27
|
+
|
28
|
+
You can create your own templates, just drop them in `.tmuxinator` with a
|
29
|
+
filename such as `basic.tmux.erb` and specify your template as such:
|
30
|
+
|
31
|
+
tmuxification create --template-name=basic
|
32
|
+
|
33
|
+
You can also edit the `default.tmux.erb` which is used when no `template-name` is
|
34
|
+
specified.
|
35
|
+
|
36
|
+
### Project name
|
37
|
+
|
38
|
+
By default the tmux project is named after the root directory of the project, you
|
39
|
+
can specify a different project name as such:
|
40
|
+
|
41
|
+
cd ~/code/my_project
|
42
|
+
tmuxification create --project-name=foobar
|
43
|
+
start_foobar
|
44
|
+
|
26
45
|
## Warning
|
27
46
|
|
28
|
-
|
47
|
+
Every project created will append a line per project to your `.zshrc` file.
|
29
48
|
|
30
49
|
## Contributing
|
31
50
|
|