Skip to content

Commit

Permalink
Init docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandrebodin committed Jul 6, 2018
1 parent df7625e commit d68e315
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,5 @@ tmuxctl

# go dep vendor
vendor/
dist/
dist/
build/
5 changes: 5 additions & 0 deletions docs/00-introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: introduction
---

Tmuxctl launches configured tmux sessions, so you can stop create over and over the same sessions.
25 changes: 25 additions & 0 deletions docs/01-installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: installation
---

You can install Tmuxctl with on of the methods bellow.

The recommended method is to run the following command, which installs `tmuxctl` in ./bin/tmuxctl by default.
```
$ curl -sf https://raw.githubusercontent.com/alexandrebodin/tmuxctl/master/install.sh | sh
```

To install `tmuxctl` in a specific folder run:
```
$ curl -sf https://raw.githubusercontent.com/alexandrebodin/tmuxctl/master/install.sh | BINDIR=/usr/local/bin sh
```

You can install `tmuxctl` using go get
```
$ go get github.com/alexandrebodin/tmuxctl
$ cd $GOPATH/src/github.com/alexandrebodin/tmuxctl
$ dep ensure -vendor-only
$ go install
```

Finally you can install it manually from one of the releases from [github](https://github.com/alexandrebodin/tmuxctl/releases)
12 changes: 12 additions & 0 deletions docs/02-getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Getting started
---

Start by creating a toml config file (by default `tmuxctl` will look for a `.tmuxctlrc` in the current dir, up the parent directories)

```toml
name="azdaz"

[[windows]]
name="win-1"
```

0 comments on commit d68e315

Please sign in to comment.