Browse Source

Adding in Mac material. Tweaking copy a bit for practice.

Signed-off-by: Mary Anthony <[email protected]>
Mary Anthony 10 years ago
parent
commit
c41de52e1b
2 changed files with 28 additions and 19 deletions
  1. 1 1
      irssi/README.md
  2. 27 18
      irssi/content.md

+ 1 - 1
irssi/README.md

@@ -75,4 +75,4 @@ Before you start to code, we recommend discussing your plans
 through a [GitHub issue](https://github.com/jfrazelle/irssi/issues), especially for more ambitious
 contributions. This gives other contributors a chance to point you in the right
 direction, give you feedback on your design, and help you find out if someone
-else is working on the same thing.
+else is working on the same thing.

+ 27 - 18
irssi/content.md

@@ -1,7 +1,7 @@
 # What is irssi?
-
-Irssi is a terminal based IRC client for UNIX systems. It also supports SILC
-and ICB protocols via plugins. Some people refer to it as 'the client of the
+ 
+Irssi is a terminal based IRC client for UNIX systems. It also supports SILC and
+ICB protocols via plugins. Some people refer to it as 'the client of the
 future'.
 
 > [irssi.org](http://irssi.org)
@@ -10,27 +10,36 @@ future'.
 
 # How to use this image
 
-Since no two users of irssi are likely to configure it exactly alike, this
-image does not come with any default configuration.
-
-Please refer to [upstream's excellent (and comprehensive)
-documentation](http://irssi.org/documentation) on the subject of
-configuring irssi for your needs.
+Because it is unlikely any two irssi users have the same configuration
+preferences, this image does not include an irssi configuration. To configure
+irssi to your liking, please refer to [upstream's excellent (and comprehensive)
++documentation](http://irssi.org/documentation).
 
 Be sure to also checkout the [awesome
 scripts](https://github.com/irssi/scripts.irssi.org) you can download to
 customize your irssi configuration.
 
+
 ## Directly via bind mount
 
-    docker run -it --name my-running-irssi -e TERM \
-        -u $(id -u):$(id -g) -v $HOME/.irssi:/home/user/.irssi:ro \
-        -v /etc/localtime:/etc/localtime:ro \
-        irssi
+On a Linux system, build and launch a container named `my-running-irssi` like
+this:
+
+    docker run -it --name my-running-irssi -e TERM \ -u $(id -u):$(id -g) -v
+    $HOME/.irssi:/home/user/.irssi:ro \ -v /etc/localtime:/etc/localtime:ro \
+    irssi
+
+On a Mac OS X system, run the same image using:
+
+	docker run -it --name my-running-irssi -e TERM -u $(id -u):$(id -g) \ -v
+	$HOME/.irssi:/home/user/.irssi:ro  irssi
+
+You omit `/etc/localtime` on Mac OS X because `boot2docker` doesn't use this
+file.
 
-    # in Docker 1.5 you can use the --read-only flag
-    docker run -it --name my-running-irssi -e TERM \
-        -u $(id -u):$(id -g) -v $HOME/.irssi:/home/user/.irssi --read-only \
-        -v /etc/localtime:/etc/localtime \
-        irssi
+Of course, you can name your image anything you like. In Docker 1.5 you can also
+use the `--read-only` mount flag. For example, on Linux:
 
+    docker run -it --name my-running-irssi -e TERM \ -u $(id -u):$(id -g) -v
+    $HOME/.irssi:/home/user/.irssi --read-only \ -v
+    /etc/localtime:/etc/localtime \ irssi