Skip to content

Commit 60ba78c

Browse files
Add instructions
1 parent a73cbea commit 60ba78c

File tree

1 file changed

+45
-2
lines changed

1 file changed

+45
-2
lines changed

README.md

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,48 @@
11
## SHMUX
2-
Shmux is a tmux session management tool written purely in shell script.
2+
Shmux is a tmux session management tool written purely in shell script. It's designed to be a simple and lightweight project layout management tool. You can specify a layout for any project, including root directory, windows, panes, and programs to run in each pane.
3+
4+
It's also a little bit of a sassy bitch, so be prepared for that.
35

46
### Installation
5-
TBD
7+
#### You'll want to clone this repository to a base dir.
8+
```bash
9+
git clone https://github.com/typecraft-dev/shmux.git
10+
```
11+
#### Then, source the management.sh file
12+
*zsh*
13+
```bash
14+
# Add this to your .zshrc
15+
source ~/management.sh
16+
```
17+
18+
*bash*
19+
```bash
20+
# add this to your .bashrc
21+
source ~/management.sh
22+
```
23+
24+
*fish*
25+
``` bash
26+
# fuck you
27+
```
28+
29+
### Usage
30+
31+
#### Create a new project layout
32+
You can create a new project and open the example template file
33+
```bash
34+
new_project "project_name"
35+
```
36+
Then, you can edit the template file to suit your needs.
37+
38+
#### Edit your project layout
39+
Any time you want to edit the layout to a project. Just do it. moron
40+
```bash
41+
edit_project "project_name"
42+
```
43+
#### Load your project
44+
When you open a new shell, you can just load this shit. No biggie, nerd.
45+
```bash
46+
load_project "project_name"
47+
```
48+
this will load tmux and attach to the layout you defined in "project_name"

0 commit comments

Comments
 (0)