summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorLi Haoyi <haoyi@dropbox.com>2014-09-05 14:17:29 -0700
committerLi Haoyi <haoyi@dropbox.com>2014-09-05 14:17:29 -0700
commitb9624be0c341ad070869497d2d10db0bb6beb3ed (patch)
treeee6e5ee7b7c07248acbf9b6f97911d6541c72572 /readme.md
parentfa3b7505ee26c4db0abbe72a4139ea4dafaaad60 (diff)
downloadworkbench-b9624be0c341ad070869497d2d10db0bb6beb3ed.tar.gz
workbench-b9624be0c341ad070869497d2d10db0bb6beb3ed.tar.bz2
workbench-b9624be0c341ad070869497d2d10db0bb6beb3ed.zip
0.2.0
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index 9616a7a..08ae7c6 100644
--- a/readme.md
+++ b/readme.md
@@ -20,7 +20,7 @@ resolvers += "spray repo" at "http://repo.spray.io"
resolvers += "Typesafe repository" at "http://repo.typesafe.com/typesafe/releases/"
-addSbtPlugin("com.lihaoyi" % "workbench" % "0.1.5")
+addSbtPlugin("com.lihaoyi" % "workbench" % "0.2.0")
```
- Add to your `build.sbt`
```scala
@@ -83,6 +83,19 @@ You can force the clean-up-and-reboot to happen from the browser via the shortcu
With this done, you should be receiving the SBT logspam (compilation, warnings, errors) in your browse console, and the page should be automatically refreshing/updating when the application gets recompiled. If you have problems setting this up, try starting from the [example app](https://github.com/lihaoyi/workbench-example-app) and working from there.
+
+# Development
+
+To develop, go into `example/` and run `sbt ~fastOptJS`. Then you can go to
+
+```
+http://localhost:12345/target/scala-2.11/classes/index-dev.html
+```
+
+and see a small sierpinski-triangle application. Editing the code within `example/` should cause the SBT log-spam to appear in the browser console, and changes (e.g. changing the color of the background fill) should cause a recompile and updating of the browser animation.
+
+To make changes to workbench, modify the workbench source code and stop/re-run `sbt ~fastOptJS`. When workbench finishes re-compiling, SBT re-starts and the page becomes accessible, your changes to workbench will take effect. You can replace `fullOptJs` in the `built.sbt` file with `fastOptJS`, and swapping the reference to `client-opt.js` to `client-fastopt.js`, if you want to speed up the development cycle.
+
Pull requests welcome!
License