Permalink
Browse files

Preparing Scala project files

  • Loading branch information...
1 parent 867bee0 commit b8b252ac5b5b198eb7afc728d94102278c20d3b3 @xerial xerial committed Feb 7, 2013
Showing with 700 additions and 17 deletions.
  1. +18 −17 .gitignore
  2. +60 −0 DEVELOP.md
  3. +438 −0 bin/sbt
  4. +150 −0 project/Build.scala
  5. +9 −0 project/plugins.sbt
  6. +24 −0 src/test/scala/MySpec.scala
  7. +1 −0 version.sbt
View
@@ -1,17 +1,18 @@
-*.class
-*.log
-*~
-
-# sbt specific
-bin/.lib
-target/
-lib_managed/
-src_managed/
-project/boot/
-project/plugins/project/
-
-# Scala-IDE specific
-.scala_dependencies
-
-# IntelliJ specific
-.idea*
+*.class
+*.log
+*~
+
+# sbt specific
+bin/.lib
+dist/*
+target/
+lib_managed/
+src_managed/
+project/boot/
+project/plugins/project/
+
+# Scala-IDE specific
+.scala_dependencies
+
+# IntelliJ specific
+.idea*
View
@@ -0,0 +1,60 @@
+UTGB Devnote
+=========
+### Contents
+
+scala-min project includes:
+- Sample Scala codes.
+- [ScalaTest](http://www.scalatest.org/) examples
+- Pre-configured settings for developing with IntelliJ IDE
+- A command for packaging projects with [sbt-pack](http://github.com/xerial/sbt-pack) plugin.
+ - `sbt-pack` also generates installation scripts for you programs.
+
+### Usage
+
+Download tar.gz archive of this project, then extract the contents:
+
+**Run tests**
+
+ $ bin/sbt test
+
+**Run tests when updates of source codes are detected**
+
+ $ bin/sbt "~test"
+
+**Run specific tests maching a pattern**
+
+ $ bin/sbt "~test-only *HelloTest"
+
+**Run tagged test only**
+
+ $ bin/sbt "~test -- include(test1)"
+
+**Create a runnable package**
+
+ $ bin/sbt pack
+ $ target/pack/bin/hello
+ Hello World!!
+
+**Install your program**
+
+ $ bin/sbt pack
+ $ cd target/pack; make install
+ $ ~/local/bin/hello
+ Hello World!!
+
+**Create IntelliJ project files**
+
+ $ bin/sbt gen-idea
+
+**Add dendent libraries**
+
+Edit `project/Build.scala`, then add libraries to `libraryDependences` variable.
+
+### Customize
+
+Rename the project name defined in `project/Build.scala` as you like.
+
+### ToDo
+
+- Add examples using command line parser
+
Oops, something went wrong.

0 comments on commit b8b252a

Please sign in to comment.