Skip to content

Commit

Permalink
docs: Add docker usage to readme
Browse files Browse the repository at this point in the history
Other corrections and minor readme changes.
  • Loading branch information
brianp committed Dec 29, 2019
1 parent 7555088 commit 938d3a0
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@ session.
### Download a release:

See the [releases](https://github.com/brianp/muxed/releases) page for muxed packages.
Download and untar the package as desired. The complete package contains
both `muxed`, `muxednew`, and `muxedsnapshot`.
Make sure all bins are somewhere in your `$PATH`. I
Download and untar the package as desired.
Make sure the bin is somewhere in your `$PATH`. I
generally move the bins in to `/usr/local/bin`.

```shell
Expand All @@ -39,6 +38,19 @@ $ brew tap brianp/homebrew-muxed
$ brew install muxed_bin
```

## For development

### With Docker

Docker commands are long so I use a make file that points all the commands to a
runing docker container.

$ git clone git@github.com:brianp/muxed.git
$ export MUXED_ENV=nix
$ make build
$ make start
$ make cargo cmd=test

### From source:

Have rust stable (or nightly at the risk of it not working) installed.
Expand All @@ -59,10 +71,10 @@ If this is your first run, muxed will create the `~/.muxed/` directory for you.

```shell
$ muxed new my_project
Looks like this is your first time here. Muxed could't find the configuration directory: `/home/vagrant/.muxed`
Looks like this is your first time here. Muxed could't find the configuration directory: `/root/.muxed`
Creating that now 👌
✌ The template file my_project.yml has been written to /home/vagrant/.muxed
✌ The template file my_project.yml has been written to /root/.muxed
Happy tmuxing!
```
Expand All @@ -86,9 +98,10 @@ right will have a shell listing of your current working directory.
### 2. Edit your template
Now you can use your favourite editor and make changes to the config as desired.
This makes the assumption you have an `$EDITOR` env var set.
```shell
$ $EDITOR ~/.muxed/my_project.yml
$ muxed edit my_project
```
### 3. Open TMUX with your muxed config
Expand Down

0 comments on commit 938d3a0

Please # to comment.