summaryrefslogtreecommitdiff
path: root/docs/pages/1 - Intro to Mill.md
diff options
context:
space:
mode:
authorSakib Hadžiavdić <sake92@users.noreply.github.com>2018-06-07 05:41:20 +0200
committerLi Haoyi <haoyi.sg@gmail.com>2018-06-06 20:41:20 -0700
commit8d8c951d2716873f8b1a2dd00b56a8a73ff45e31 (patch)
tree54cc9b0d8cfdf5359e80559b5286d5712f37aa2f /docs/pages/1 - Intro to Mill.md
parente34e67588be6978451fb198335ae938aa17e5964 (diff)
downloadmill-8d8c951d2716873f8b1a2dd00b56a8a73ff45e31.tar.gz
mill-8d8c951d2716873f8b1a2dd00b56a8a73ff45e31.tar.bz2
mill-8d8c951d2716873f8b1a2dd00b56a8a73ff45e31.zip
Fixed typos, wordings, formatted examples (#365)
Diffstat (limited to 'docs/pages/1 - Intro to Mill.md')
-rw-r--r--docs/pages/1 - Intro to Mill.md25
1 files changed, 13 insertions, 12 deletions
diff --git a/docs/pages/1 - Intro to Mill.md b/docs/pages/1 - Intro to Mill.md
index 7aac0149..84a9bc5d 100644
--- a/docs/pages/1 - Intro to Mill.md
+++ b/docs/pages/1 - Intro to Mill.md
@@ -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"
}
```