diff options
author | Jakob Odersky <jakob@odersky.com> | 2016-06-10 14:22:43 -0700 |
---|---|---|
committer | Jakob Odersky <jakob@odersky.com> | 2016-06-10 14:22:43 -0700 |
commit | 02ef3db67bdb2ce1a99fb3ce7ba87b19727d7826 (patch) | |
tree | 37dbeac1f37c0cd6959b1ba57d67812309e4caa1 | |
parent | 1953ca0910aa8a84f5129ab15385ebf30e63f78a (diff) | |
download | akka-serial-02ef3db67bdb2ce1a99fb3ce7ba87b19727d7826.tar.gz akka-serial-02ef3db67bdb2ce1a99fb3ce7ba87b19727d7826.tar.bz2 akka-serial-02ef3db67bdb2ce1a99fb3ce7ba87b19727d7826.zip |
Release version 3.0.1 to maven central
-rw-r--r-- | _config.yml | 4 | ||||
-rw-r--r-- | documentation/3.0/developer.md | 3 | ||||
-rw-r--r-- | documentation/3.0/manual.md | 12 | ||||
-rw-r--r-- | downloads/index.md | 3 |
4 files changed, 8 insertions, 14 deletions
diff --git a/_config.yml b/_config.yml index d4f1f1c..d73d1ea 100644 --- a/_config.yml +++ b/_config.yml @@ -1,6 +1,6 @@ # Site settings title: flow description: Serial communication library for Akka and Scala. -url: "https://www.jodersky.ch/flow" -version_latest: 3.0.0 +#url: "https://www.jodersky.ch/flow" +version_latest: 3.0.1 version_docs: 3.0 diff --git a/documentation/3.0/developer.md b/documentation/3.0/developer.md index ff4ee31..641724f 100644 --- a/documentation/3.0/developer.md +++ b/documentation/3.0/developer.md @@ -70,6 +70,5 @@ Here are some important notes on creating a release: - Run `sbt makeSite` to generate documentation in `target/site/` - Checkout GitHub Pages branch `git checkout gh-pages` - Copy contents of `target/site/` to `documentation/M.m/` - - Update symlink `documentation/current` if necessary - - Update `_site.yml` with latest version + - Update `_config.yml` with latest version - Push to GitHub diff --git a/documentation/3.0/manual.md b/documentation/3.0/manual.md index 4799b4f..4e965e9 100644 --- a/documentation/3.0/manual.md +++ b/documentation/3.0/manual.md @@ -7,12 +7,10 @@ title: User Guide {:toc} # Getting Started -Flow uses sbt as build system. To get started, add the Bintray jcenter resolver and include a dependency to flow in your project: +Flow uses sbt as build system. To get started, include a dependency to flow in your project: ~~~scala -resolvers += Resolver.jcenterRepo - -libraryDependencies += "ch.jodersky" %% "flow-core" % "3.0.0" +libraryDependencies += "ch.jodersky" %% "flow-core" % "3.0.1" ~~~ Next, you need to include flow's native library that supports communication for serial devices. @@ -30,7 +28,7 @@ It is recommended that you use the first option for testing purposes or end-user In case your kernel/architecture combination is present in the "supported platforms" table in the [downloads section]({{site.url}}/downloads/), add a second dependency to your project: ~~~scala -libraryDependencies += "ch.jodersky" % "flow-native" % "3.0.0" % "runtime" +libraryDependencies += "ch.jodersky" % "flow-native" % "3.0.1" % "runtime" ~~~ This will add a jar to your classpath containing native libraries for various platforms. At run-time, the correct library for the current platform is selected, extracted and loaded. This solution enables running applications seamlessly, as if they were pure JVM applications. @@ -51,7 +49,7 @@ Then, for every end-user application that relies on flow, manually add the nativ --- # Communication Protocol -The following is a general guide on the usage of flow. If you prefer a complete example, check out the code contained in the [flow-samples](https://github.com/jodersky/flow/tree/v3.0.0/flow-samples) directory. +The following is a general guide on the usage of flow. If you prefer a complete example, check out the code contained in the [flow-samples](https://github.com/jodersky/flow/tree/v3.0.1/flow-samples) directory. Flow's API follows that of an actor based system, where each actor is assigned specific functions involved in serial communication. The two main actor types are: @@ -188,7 +186,7 @@ Note that the manager has a deathwatch on every subscribed client. Hence, should Flow provides support for Akka streams and thus can be interfaced with reactive-streams. Support is implemented in a separate module, which needs to be added as a library dependency: ~~~scala -libraryDependencies += "ch.jodersky" %% "flow-stream" % "3.0.0" +libraryDependencies += "ch.jodersky" %% "flow-stream" % "3.0.1" ~~~ The main entry point for serial streaming is `ch.jodersky.flow.stream.Serial`. It's API is also well documented and should serve as the starting point when searching documentation on serial streaming. diff --git a/downloads/index.md b/downloads/index.md index 9b400d6..e0e22d0 100644 --- a/downloads/index.md +++ b/downloads/index.md @@ -13,9 +13,6 @@ title: Downloads Add the following to your build configuration: ~~~scala -//add resolver to Bintray's jcenter -resolvers += Resolver.jcenterRepo - //main artifact libraryDependencies += "ch.jodersky" %% "flow-core" % "{{site.version_latest}}" |