defmodule Cortex do
  @moduledoc """
  Documentation for Cortex.

  ## Features

  Cortex runs along side your elixir application.

  ### Reload

  Once added to your dependencies, it will startup automatically
  when you run `iex -S mix`.

    ```
    $ iex -S mix
    ```

  A file-watcher will keep an eye on any changes made
  in your app's `lib` and `test` directories,
  recompiling the relevant files as changes are made.

  #### Compile Failures

  Changes to a file that result in a failed compile are pretty annoying
  to deal with. Cortex will present compiler errors (with the file and line number!)
  until a clean compile is again possible.

  ### Test Runner

  When your app is run in the :test env,
  Cortex will act as a test runner.

    ```
    $ MIX_ENV=test iex -S mix
    ```

  Any change to a file in `lib` will then run tests for the
  corresponding file in `test`, and any change to a test file
  will re-run that file's tests.

  """
end