Merge pull request #15 from SethTisue/include-readme-in-jar

version 0.1.0, with readme in jar

Author: SethTisue

LICENSE.md

@@ -0,0 +1,27 @@
+Copyright (c) 2015, Typesafe Inc.  
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the Scala project nor the names of its contributors
+  may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -16,19 +16,19 @@ incremental recompile times.
 
 ## Building the plugin from source
 
-`sbt package` will create `target/scala-2.11/scala-sculpt_2.11-0.0.1.jar`.
+`sbt package` will create `target/scala-2.11/scala-sculpt_2.11-0.1.0.jar`.
 
 ## Using the plugin
 
 You can use the compiled plugin with the Scala 2.11 compiler as follows.
 
-First, make sure you have `scala-sculpt_2.11-0.0.1.jar` in your current working directory,
+Supposing you have `scala-sculpt_2.11-0.1.0.jar` in your current working directory,
 along with `spray-json_2.11-1.3.2.jar` (which you can download
 [here](http://repo1.maven.org/maven2/io/spray/spray-json_2.11/1.3.2/spray-json_2.11-1.3.2.jar).
 
 Then you can do e.g.:
 
-    scalac -Xplugin:scala-sculpt_2.11-0.0.1.jar:spray-json_2.11-1.3.2.jar \
+    scalac -Xplugin:scala-sculpt_2.11-0.1.0.jar:spray-json_2.11-1.3.2.jar \
       -Xplugin-require:sculpt \
       -P:sculpt:out=dep.json \
       Dep.scala
@@ -125,7 +125,7 @@ manipulation, e.g. in the REPL.
 
 Now in a Scala 2.11 REPL with the same JARs on the classpath:
 
-    scala -classpath scala-sculpt_2.11-0.0.1.jar:spray-json_2.11-1.3.2.jar
+    scala -classpath scala-sculpt_2.11-0.1.0.jar:spray-json_2.11-1.3.2.jar
 
 If we load `dep.json` as follows, we'll see the following graph:
 

build.sbt

@@ -1,6 +1,8 @@
+// Copyright (C) 2015 Typesafe Inc. <http://typesafe.com>
+
 organization  := "com.typesafe"
 name          := "scala-sculpt"
-version       := "0.0.1"
+version       := "0.1.0"
 licenses      := Seq("Apache License v2.0" -> url("http://www.apache.org/licenses/LICENSE-2.0"))
 homepage      := Some(url("http://github.com/typesafehub/scala-sculpt"))
 
@@ -22,6 +24,10 @@ scalacOptions ++= Seq(
   "-Xfatal-warnings"
 )
 
+mappings in (Compile, packageBin) ++= Seq(
+  (baseDirectory.value / "README.md") -> "README.md",
+  (baseDirectory.value / "LICENSE.md") -> "LICENSE.md")
+
 pomExtra := (<scm>
   <url>https://github.com/typesafehub/scala-sculpt.git</url>
   <connection>scm:https://github.com/typesafehub/scala-sculpt.git</connection></scm>)

src/main/scala/scala/tools/sculpt/cmd/package.scala

@@ -1,3 +1,5 @@
+// Copyright (C) 2015 Typesafe Inc. <http://typesafe.com>
+
 package scala.tools.sculpt
 
 import spray.json._

src/main/scala/scala/tools/sculpt/model/FullDependenciesPrinter.scala

@@ -1,3 +1,5 @@
+// Copyright (C) 2015 Typesafe Inc. <http://typesafe.com>
+
 package scala.tools.sculpt.model
 
 import spray.json._

src/main/scala/scala/tools/sculpt/model/ModelJsonProtocol.scala

@@ -1,3 +1,5 @@
+// Copyright (C) 2015 Typesafe Inc. <http://typesafe.com>
+
 package scala.tools.sculpt.model
 
 import spray.json._

src/main/scala/scala/tools/sculpt/model/TreePrinter.scala

@@ -1,3 +1,5 @@
+// Copyright (C) 2015 Typesafe Inc. <http://typesafe.com>
+
 package scala.tools.sculpt.model
 
 object TreePrinter {

src/main/scala/scala/tools/sculpt/model/model.scala

@@ -1,3 +1,5 @@
+// Copyright (C) 2015 Typesafe Inc. <http://typesafe.com>
+
 package scala.tools.sculpt.model
 
 import scala.StringBuilder

src/main/scala/scala/tools/sculpt/plugin/ExtractDependencies.scala

@@ -1,3 +1,5 @@
+// Copyright (C) 2015 Typesafe Inc. <http://typesafe.com>
+
 package scala.tools.sculpt.plugin
 
 import scala.collection.mutable

src/main/scala/scala/tools/sculpt/plugin/SculptPlugin.scala

@@ -1,3 +1,5 @@
+// Copyright (C) 2015 Typesafe Inc. <http://typesafe.com>
+
 package scala.tools.sculpt.plugin
 
 import java.io.File