summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLi Haoyi <haoyi.sg@gmail.com>2018-08-13 17:31:56 +0800
committerLi Haoyi <haoyi.sg@gmail.com>2018-08-13 17:35:32 +0800
commiteddd2fdeb899e78ee605afc7b905c922a1f154ac (patch)
tree18f3c205b739da8c6da442a1ec9555177c2ab8cc /docs
parentc4be0ad68e2eff9fe2d5fffdcb7d33ca539f6de5 (diff)
downloadcask-eddd2fdeb899e78ee605afc7b905c922a1f154ac.tar.gz
cask-eddd2fdeb899e78ee605afc7b905c922a1f154ac.tar.bz2
cask-eddd2fdeb899e78ee605afc7b905c922a1f154ac.zip
0.0.60.0.6
Diffstat (limited to 'docs')
-rw-r--r--docs/pages/1 - Cask: a Scala HTTP micro-framework .md14
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/pages/1 - Cask: a Scala HTTP micro-framework .md b/docs/pages/1 - Cask: a Scala HTTP micro-framework .md
index fff6270..b87c5a6 100644
--- a/docs/pages/1 - Cask: a Scala HTTP micro-framework .md
+++ b/docs/pages/1 - Cask: a Scala HTTP micro-framework .md
@@ -23,8 +23,6 @@ Getting Started
The easiest way to begin using Cask is by downloading the
[Mill](http://www.lihaoyi.com/mill/) example project:
-- Install [Mill](http://www.lihaoyi.com/mill/)
-
- Unzip one of the example projects available on this page (e.g. above) into a
folder. This should give you the following files:
@@ -37,7 +35,7 @@ app/test/src/ExampleTests.scala
- `cd` into the folder, and run
```bash
-mill -w app.runBackground
+./cask -w app.runBackground
```
This will server up the Cask application on `http://localhost:8080`. You can
@@ -64,7 +62,7 @@ These HTTP calls are part of the test suite for the example project, which you
can run using:
```bash
-mill -w app.test
+./cask -w app.test
```
Cask is just a Scala library, and you can use Cask in any existing Scala project
@@ -78,13 +76,19 @@ ivy"com.lihaoyi::cask:0.1.0"
"com.lihaoyi" %% "cask" % "0.1.0"
```
+The `./cask` command is just a wrapper around the
+[Mill build tool](http://www.lihaoyi.com/mill/); the `build.sc` files you see in
+all examples are Mill build files, and you can use your own installation of Mill
+instead of `./cask` if you wish. All normal Mill commands and functionality
+works for `./cask`.
+
Using Cask
----------
The following examples will walk you through how to use Cask to accomplish tasks
common to anyone writing a web application. Each example comes with a
downloadable example project with code and unit tests, which you can use via the
-same `mill -w app.runBackground` or `mill -w app.test` workflows we saw above.
+same `./cask -w app.runBackground` or `./cask -w app.test` workflows we saw above.
### Minimal Example