aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Odersky <jodersky@gmail.com>2013-06-30 20:44:42 +0200
committerJakob Odersky <jodersky@gmail.com>2013-06-30 20:44:48 +0200
commit48fbe3b48297860f9b5b3c431fb8e318e5ec7588 (patch)
treebb43bdd65d5e462fff05b1cae403b327d181f360
parent3f39d15954a8fe61b5ca42b36906dc32a9e12597 (diff)
downloadakka-serial-48fbe3b48297860f9b5b3c431fb8e318e5ec7588.tar.gz
akka-serial-48fbe3b48297860f9b5b3c431fb8e318e5ec7588.tar.bz2
akka-serial-48fbe3b48297860f9b5b3c431fb8e318e5ec7588.zip
'rename flow-main to flow
-rw-r--r--README.md6
-rw-r--r--project/Build.scala2
2 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index ae06433..4598e2c 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ Since hardware is involved in serial communication, a Scala-only solution is not
## Usage
(this section will be updated as soon as a maven repository is available)
-Clone the repository and run `sbt flow-main/publish-local` to publish the library locally. From there on, you may use the library in any project simply by adding a library dependency to it.
+Clone the repository and run `sbt flow/publish-local` to publish the library locally. From there on, you may use the library in any project simply by adding a library dependency to it.
libraryDependencies += "com.github.jodersky" % "flow" % "1.0-SNAPSHOT"
@@ -59,7 +59,7 @@ The directories of interest in a build are:
With this structure in mind, building a complete distribution of flow involves (sbt commands are given in code tags):
- 1. compiling java/scala sources: `flow-main/compile`
+ 1. compiling java/scala sources: `flow/compile`
This simply compiles any scala and java sources as with any standard sbt project.
2. compiling and linking native sources for the current platform: `flow-native-<os>/native:link`
@@ -70,7 +70,7 @@ With this structure in mind, building a complete distribution of flow involves (
3. locally publishing the native binary to include in final jar: `flow-native-<os>/publishNative`
This copies the compiled binary (for the current platform) to the flow-binaries folder.
- 4. packaging the final jar: `flow-main/package`
+ 4. packaging the final jar: `flow/package`
This copies the latest version-compatible shared libraries of flow-binaries to the final jar.
The idea behind publishing to an intermediate location is to provide a central collection of binaries that may be created from different systems and included in one final jar (a nice corollary is that anyone can compile native sources on a platform, submit a pull request and have the binary included). As such, if you are only modifying java/scala sources, it is not necessary to compile any native sources and steps 2 and 3 from above may be omitted.
diff --git a/project/Build.scala b/project/Build.scala
index 1f1ee74..e8b0a27 100644
--- a/project/Build.scala
+++ b/project/Build.scala
@@ -24,7 +24,7 @@ object FlowBuild extends Build {
connectInput in run := true)
lazy val main: Project = (
- Project("flow-main", file("flow-main"))
+ Project("flow", file("flow-main"))
settings (commonSettings: _*)
settings (
libraryDependencies ++= Seq(