diff options
Diffstat (limited to 'docs/pages')
| -rw-r--r-- | docs/pages/1 - Intro to Mill.md | 42 | ||||
| -rw-r--r-- | docs/pages/6 - Extending Mill.md | 4 |
2 files changed, 27 insertions, 19 deletions
diff --git a/docs/pages/1 - Intro to Mill.md b/docs/pages/1 - Intro to Mill.md index b912bf14..63b69601 100644 --- a/docs/pages/1 - Intro to Mill.md +++ b/docs/pages/1 - Intro to Mill.md @@ -17,6 +17,14 @@ external subprocesses. ## Installation +### OS X + +Installation via [homebrew](https://github.com/Homebrew/homebrew-core/blob/master/Formula/mill.rb): + +```sh +brew install mill +``` + ### Arch Linux Arch Linux has an [AUR package for mill](https://aur.archlinux.org/packages/mill/): @@ -31,14 +39,14 @@ To get started, download Mill and install it into your system via the following `curl`/`chmod` command: ```bash -sudo curl -L -o /usr/local/bin/mill https://github.com/lihaoyi/mill/releases/download/0.1.4/0.1.4 && sudo chmod +x /usr/local/bin/mill +sudo curl -L -o /usr/local/bin/mill https://github.com/lihaoyi/mill/releases/download/0.1.6/0.1.6 && sudo chmod +x /usr/local/bin/mill ``` ### Development Releases More recent, unstable versions of Mill are also [available](https://github.com/lihaoyi/mill/releases/tag/unstable), if you want -to try out the latest features and improvements that are currently in master. +to try out the latest features and improvements that are currently in master. Come by our [Gitter Channel](https://gitter.im/lihaoyi/mill) if you want to ask questions or say hi! @@ -97,7 +105,7 @@ $ mill foo.repl # start an Ammonite REPL within your project ``` You can run `mill resolve __` to see a full list of the different tasks that are -available, `mill resolve foo._` to see the tasks within `foo`, `mill describe +available, `mill resolve foo._` to see the tasks within `foo`, `mill inspect foo.compile` to see what an individual task depends on, or `mill show foo.scalaVersion` to inspect the output of any task. @@ -320,10 +328,10 @@ mill resolve __ # list every module or task recursively mill resolve foo.__ # list every task recursively within the foo module ``` -### describe +### inspect ```bash -$ mill describe core.run +$ mill inspect core.run core.run(ScalaModule.scala:211) Inputs: @@ -333,26 +341,26 @@ Inputs: core.forkEnv ``` -`describe` is a more verbose version of [resolve](#resolve). In addition to +`inspect` is a more verbose version of [resolve](#resolve). In addition to printing out the name of one-or-more tasks, it also display's it's source location and a list of input tasks. This is very useful for debugging and interactively exploring the structure of your build from the command line. -`describe` also works with the same `_`/`__` wildcard/query syntaxes that +`inspect` also works with the same `_`/`__` wildcard/query syntaxes that [all](#all)/[resolve](#resolve) do: ```bash -mill describe foo.compile -mill describe foo.{compile,run} -mill describe "foo.{compile,run}" -mill describe foo.compile foo.run -mill describe _.compile -mill describe __.compile -mill describe _ -mill describe foo._ -mill describe __ -mill describe foo._ +mill inspect foo.compile +mill inspect foo.{compile,run} +mill inspect "foo.{compile,run}" +mill inspect foo.compile foo.run +mill inspect _.compile +mill inspect __.compile +mill inspect _ +mill inspect foo._ +mill inspect __ +mill inspect foo._ ``` ### show diff --git a/docs/pages/6 - Extending Mill.md b/docs/pages/6 - Extending Mill.md index a6c096a6..75b7643a 100644 --- a/docs/pages/6 - Extending Mill.md +++ b/docs/pages/6 - Extending Mill.md @@ -20,7 +20,7 @@ you're done. For subprocess/filesystem operations, you can use the [Ammonite-Ops](http://ammonite.io/#Ammonite-Ops) library that comes bundled with -Mill, or even plain `java.nio`/`java.lang.Process. Each target gets it's own +Mill, or even plain `java.nio`/`java.lang.Process`. Each target gets it's own [T.ctx().dest](http://www.lihaoyi.com/mill/page/tasks#millutilctxdestctx) folder that you can use to place files without worrying about colliding with other targets. @@ -177,7 +177,7 @@ def idea(ev: Evaluator[Any]) = T.command{ ``` Many built-in tools are implemented as custom evaluator commands: -[all](intro.html#all), [describe](intro.html#describe), +[all](intro.html#all), [inspect](intro.html#inspect), [resolve](intro.html#resolve), [show](intro.html#show). If you want a way to run Mill commands and programmatically manipulate the tasks and outputs, you do so with your own evaluator command. |