From 814ae40ae8d81efc7d867a5213b61f4ab7dad6d8 Mon Sep 17 00:00:00 2001 From: Johannes Rudolph Date: Sun, 15 Jul 2012 12:02:33 +0300 Subject: [PATCH] add some more usage info for multi-module projects --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c719037d8..fc5380845 100644 --- a/README.md +++ b/README.md @@ -25,13 +25,25 @@ Then, add the following to your `/build.sbt` (that's not `project/ net.virtualvoid.sbt.graph.Plugin.graphSettings ``` -or if you use the full configuration, add +OR, alternatively, if you use the full configuration, i.e. you define your build definition in `project/build.scala`, for example, +to define a multi-module project, you should add ```scala .settings(net.virtualvoid.sbt.graph.Plugin.graphSettings: _*) ``` -to your project definition. +to each of the project definitions for which you want to use the plugin. The definition of your project should then +look approximately this way: + +```scala +object MyBuild extends Build { + val proj = + Project("my-project", file("base")) + .settings(net.virtualvoid.sbt.graph.Plugin.graphSettings: _*) +} +``` + +Check out the [example project] for a skeleton build setup. Tasks & Settings ---------------- @@ -69,4 +81,6 @@ License Copyright (c) 2011, 2012 Johannes Rudolph -Published under the [Apache License 2.0](http://en.wikipedia.org/wiki/Apache_license). \ No newline at end of file +Published under the [Apache License 2.0](http://en.wikipedia.org/wiki/Apache_license). + +[example project]: https://gist.github.com/3106492 \ No newline at end of file