Set up Mix file to generate a standalone executable.

deps/rabbitmq_cli/README.md

@@ -6,27 +6,51 @@ This is still very much a work in progress right now. For production use, go
 with the `rabbitmqctl` distributed with the `rabbitmq-server` repo.
 
 
+# Building
+
+### Requirements
+
+Building RabbitMQCtl requires Elixir 1.2.2 or greater. As Elixir runs on Erlang, you must also have Erlang installed (which you would need for RabbitMQ anyway).
+
+RabbitMQCtl requires the [rabbitmq-common](https://github.com/rabbitmq/rabbitmq-common) repo. This library is included as a dependency in the `mix.exs` file, though, so the `mix deps.*` commands in the build process below will pull it in.
+
+### Building a Standalone Executable
+
+To generate an executable `rabbitmqctl`, run the following commands:
+
+```
+mix deps.get
+mix deps.compile
+mix escript.build
+```
+
+# Using
+
+`rabbitmqctl [-n node] [-t timeout] [-q] {command} [command options...]`
+
+See the [man page](https://www.rabbitmq.com/man/rabbitmqctl.1.man.html) for a ful list of options.
+
+
 # Testing
 
 Assuming you have:
+
  * installed [Elixir](http://elixir-lang.org/install.html)
  * set up an active instance of RabbitMQ
 
 you can simply run `mix test` within the project root directory.
 
-NOTE: You will see the following message several times:
+NOTE: You may see the following message several times:
 
 ```
 warning: variable context is unused
 ```
 
-This is nothing to be alarmed about; we're currently using `setup context`
-function in Mix to start a new distributed node and connect it to the 
-RabbitMQ server. It complains because we don't actually use the context 
-dictionary, but it's fine otherwise.
+This is nothing to be alarmed about; we're currently using `setup context` functions in Mix to start a new distributed node and connect it to the RabbitMQ server. It complains because we don't actually use the context dictionary, but it's fine otherwise.
 
 
-# Adding a New Command (the easy way)
+# Developing
+## Adding a New Command (the easy way)
 
 RabbitMQCtl uses Elixir's `eval_string/2` method to match the command-line
 argument to the right module. This keeps the main module a reasonable size,
@@ -40,21 +64,18 @@ For example, to add a new command `rabbitmqctl egg_salad`:
 
 1. Create a new test file `test/egg_salad_command_test.exs`.
 
-2. Define a module `EggSaladCommandTest` that runs tests against a function
+2. In your new test file, define a module `EggSaladCommandTest` that runs tests against a function
   `EggSaladCommand.egg_salad`.
 
 3. Create a new source file `test/egg_salad_command.exs`.
 
-4. Define a module `EggSaladCommand` that implements the `egg_salad/0`
+4. In your new source file, define a module `EggSaladCommand` that implements the `egg_salad/0`
   function.
 
 See `src/status_command.ex` and `test/status_command_test.exs` for simple
 examples of this format.
 
 
-## Installation
-
-
 ## License
 
 RabbitMQCtl is [licensed under the MPL](LICENSE-MPL-RabbitMQ).

deps/rabbitmq_cli/mix.exs

@@ -24,7 +24,7 @@ defmodule RabbitMQCtl.Mixfile do
      elixir: "~> 1.2",
      build_embedded: Mix.env == :prod,
      start_permanent: Mix.env == :prod,
-     escript: [main_module: RabbitMQCtl],
+     escript: escript_config,
      deps: deps]
   end
 
@@ -53,4 +53,10 @@ defmodule RabbitMQCtl.Mixfile do
       }
     ]
   end
+
+  defp escript_config do
+    [
+      main_module: RabbitMQCtl
+    ]
+  end
 end