diff options
author | Li Haoyi <haoyi.sg@gmail.com> | 2018-06-09 11:49:39 -0700 |
---|---|---|
committer | Li Haoyi <haoyi.sg@gmail.com> | 2018-06-09 11:49:39 -0700 |
commit | eb7082b284c35e968cf6ef8dff19274870b8fbe4 (patch) | |
tree | b4dc222bd93800eed7c5caa3b565b2f8b9ecf0b9 /docs/pages/1 - Intro to Mill.md | |
parent | 9d65a0e06338611bbc36854123683f29929e6e08 (diff) | |
parent | e96b57ef1a9a1b47098d7d09a7d1422635d1af2c (diff) | |
download | mill-eb7082b284c35e968cf6ef8dff19274870b8fbe4.tar.gz mill-eb7082b284c35e968cf6ef8dff19274870b8fbe4.tar.bz2 mill-eb7082b284c35e968cf6ef8dff19274870b8fbe4.zip |
Merge branch 'master' of github.com:lihaoyi/mill
Diffstat (limited to 'docs/pages/1 - Intro to Mill.md')
-rw-r--r-- | docs/pages/1 - Intro to Mill.md | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/docs/pages/1 - Intro to Mill.md b/docs/pages/1 - Intro to Mill.md index 7aac0149..760f0fcb 100644 --- a/docs/pages/1 - Intro to Mill.md +++ b/docs/pages/1 - Intro to Mill.md @@ -36,7 +36,7 @@ pacaur -S mill ### Windows To get started, download Mill from: -https://github.com/lihaoyi/mill/releases/download/0.2.2/0.2.3, and save it as +https://github.com/lihaoyi/mill/releases/download/0.2.3/0.2.3, and save it as `mill.bat`. Mill also works on a sh environment on Windows (e.g., @@ -80,7 +80,7 @@ The simplest Mill build for a Java project looks as follows: ```scala // build.sc -import mill._, mill.scalalib._ +import mill._, scalalib._ object foo extends JavaModule { @@ -91,8 +91,7 @@ The simplest Mill build for a Scala project looks as follows: ```scala // build.sc -import mill._ -import mill.scalalib._ +import mill._, scalalib._ object foo extends ScalaModule { def scalaVersion = "2.12.4" @@ -152,7 +151,7 @@ time. ## Output -Mill puts all it's output in the top-level `out/` folder. The above commands +Mill puts all its output in the top-level `out/` folder. The above commands would end up in: ```text @@ -168,9 +167,9 @@ Within the output folder for each task, there's a `meta.json` file containing the metadata returned by that task, and a `dest/` folder containing any files that the task generates. For example, `out/foo/compile/dest/` contains the compiled classfiles, while `out/foo/assembly/dest/` contains the self-contained -assembly with the project's classfiles jar-ed up with all it's dependencies. +assembly with the project's classfiles jar-ed up with all its dependencies. -Given a task `foo.bar`, all it's output and results can be found be within it's +Given a task `foo.bar`, all its output and results can be found be within its respective `out/foo/bar/` folder. ## Multiple Modules @@ -178,7 +177,8 @@ respective `out/foo/bar/` folder. ### Java Example ```scala // build.sc -import mill._, mill.scalalib._ +import mill._, scalalib._ + object foo extends JavaModule object bar extends JavaModule { def moduleDeps = Seq(foo) @@ -188,7 +188,8 @@ object bar extends JavaModule { ### Scala Example ```scala // build.sc -import mill._, mill.scalalib._ +import mill._, scalalib._ + object foo extends ScalaModule { def scalaVersion = "2.12.4" } @@ -244,8 +245,8 @@ Modules can also be nested: ```scala // build.sc -import mill._ -import mill.scalalib._ +import mill._, scalalib._ + object foo extends ScalaModule { def scalaVersion = "2.12.4" object bar extends ScalaModule { @@ -388,7 +389,7 @@ Inputs: ``` `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 +printing out the name of one-or-more tasks, it also displays its 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. @@ -614,7 +615,7 @@ build: // build.sc import mill._, scalalib._ -object foo extends ScalaModule{ +object foo extends ScalaModule { def scalaVersion = "2.12.4" } ``` |