From a123bd8dbb98587bbc59535ea9155fefaaf828a1 Mon Sep 17 00:00:00 2001 From: Jakob Odersky Date: Sun, 15 Jan 2017 20:03:37 -0800 Subject: Rename project --- _config.yml | 6 ++-- _includes/header.html | 5 ++-- _snippet.md | 2 +- assets/images/logo.png | Bin 3207 -> 0 bytes assets/images/logo.svg | 70 -------------------------------------------- documentation/3.0/manual.md | 14 +++++++++ documentation/index.md | 32 ++++++-------------- downloads/index.md | 20 ++++++------- index.html | 4 +-- 9 files changed, 41 insertions(+), 112 deletions(-) delete mode 100644 assets/images/logo.png delete mode 100644 assets/images/logo.svg diff --git a/_config.yml b/_config.yml index 4d55e0d..4fda29d 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.4 -version_docs: 3.0 +url: "https://www.jodersky.ch/akka-serial" +version_latest: 4.0.0 +version_docs: 4.0 diff --git a/_includes/header.html b/_includes/header.html index 31d8820..3546fb6 100644 --- a/_includes/header.html +++ b/_includes/header.html @@ -4,14 +4,13 @@
- flow logo - flow + akka-serial
diff --git a/_snippet.md b/_snippet.md index 65598ec..32c9e6b 100644 --- a/_snippet.md +++ b/_snippet.md @@ -1,8 +1,8 @@ {% highlight scala %} import akka.actor.{Actor, ActorLogging, ActorRef, Props, Terminated} import akka.io.IO +import akka.serial.{Serial, SerialSettings} import akka.util.ByteString -import com.github.jodersky.flow.{Serial, SerialSettings} /** * Sample actor representing a simple terminal. diff --git a/assets/images/logo.png b/assets/images/logo.png deleted file mode 100644 index 3410157..0000000 Binary files a/assets/images/logo.png and /dev/null differ diff --git a/assets/images/logo.svg b/assets/images/logo.svg deleted file mode 100644 index ffafba0..0000000 --- a/assets/images/logo.svg +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - diff --git a/documentation/3.0/manual.md b/documentation/3.0/manual.md index 3cc5545..ff23d1e 100644 --- a/documentation/3.0/manual.md +++ b/documentation/3.0/manual.md @@ -6,6 +6,20 @@ title: User Guide * TOC {:toc} +----- + +## Migrating from 2.x to 3.x + +The latest major release, 3, introduces some source compatibility-breaking changes: + +- Organization and packages have been changed from `com.github.jodersky` to `ch.jodersky` +- A new major version of the native library has been released, `libflow4` + +It should be sufficient to change any imports that previously used "com.github.jodersky.flow" to "ch.jodersky.flow". +In case you manually installed the native library, you will also need to upgrade to libflow4 (see the Developer Guide for more information). + +----- + # Getting Started Flow uses sbt as build system. To get started, include a dependency to flow in your project: diff --git a/documentation/index.md b/documentation/index.md index 2211f8a..e07de2a 100644 --- a/documentation/index.md +++ b/documentation/index.md @@ -8,45 +8,31 @@ title: Documentation Start by reading the manual and checking out some examples. - [Manual]({{site.version_docs}}/manual) - Explains how to get started and how to use all features. Definitive guide to using flow. + Explains how to get started and how to use all features. Definitive guide to using akka-serial. -- [Examples](https://github.com/jodersky/flow/tree/master/flow-samples) +- [Examples](https://github.com/jodersky/akka-serial/tree/master/samples) See some very simple, working demo applications. - [Developer Guide]({{site.version_docs}}/developer) - Instructions on building, testing and publishing flow. + Instructions on building, testing and publishing akka-serial. -- [API documentation]({{site.version_docs}}/api/index.html#ch.jodersky.flow.Serial$) - Browse flow's API. +- [API documentation]({{site.version_docs}}/api/index.html#akka.serial.Serial$) + Browse akka-serial's API. ## Help Have a question or suggestion? Found a bug? There are several channels to get help. -- [Issues](https://github.com/jodersky/flow/issues) +- [Issues](https://github.com/jodersky/akka-serial/issues) Check known issues or file a new one. This is also the place to go for long questions or propositions. -- [Chat](https://gitter.im/jodersky/flow) +- [Chat](https://gitter.im/jodersky/akka-serial) Gitter chat for simple inquiries. ## Use cases -Get inspired by some real projects that use flow. +Get inspired by some real projects that use akka-serial. - [Virtual Cockpit](https://github.com/project-condor/mavigator) part of [Project Condor](https://project-condor.github.io/), a do-it-yourself drone. - [Hyperion](https://github.com/mthmulders/hyperion) back-end, part of a web-based energy dashboard for "smart meters". -- [(add yours by opening an issue)](https://github.com/jodersky/flow/issues) - ------ - -## Migrating from 2.x to 3.x - -The latest major release, 3, introduces some source compatibility-breaking changes: - -- Organization and packages have been changed from `com.github.jodersky` to `ch.jodersky` -- A new major version of the native library has been released, `libflow4` - -It should be sufficient to change any imports that previously used "com.github.jodersky.flow" to "ch.jodersky.flow". -In case you manually installed the native library, you will also need to upgrade to libflow4 (see the Developer Guide for more information). - ------ +- [(add yours by opening an issue)](https://github.com/jodersky/akka-serial/issues) diff --git a/downloads/index.md b/downloads/index.md index 946a813..7b998fa 100644 --- a/downloads/index.md +++ b/downloads/index.md @@ -13,14 +13,14 @@ title: Downloads Add the following to your build configuration: ~~~scala -//main artifact -libraryDependencies += "ch.jodersky" %% "flow-core" % "{{site.version_latest}}" +// main artifact +libraryDependencies += "ch.jodersky" %% "akka-serial-core" % "{{site.version_latest}}" -//"fat" jar containing native libraries -libraryDependencies += "ch.jodersky" % "flow-native" % "{{site.version_latest}}" % "runtime" +// "fat" jar containing native libraries +libraryDependencies += "ch.jodersky" % "akka-serial-native" % "{{site.version_latest}}" % "runtime" -//(experimental) support for Akka streams -libraryDependencies += "ch.jodersky" %% "flow-stream" % "{{site.version_latest}}" +// support for Akka streams +libraryDependencies += "ch.jodersky" %% "akka-serial-stream" % "{{site.version_latest}}" ~~~ @@ -43,16 +43,16 @@ libraryDependencies += "ch.jodersky" %% "flow-stream" % "{{site.version_latest}}

*These are the platforms for which a native library is included in the release. -Flow is POSIX compatible so it can be built for a lot more platforms.

+akka-serial is POSIX compatible so it can be built for a lot more platforms.

## Release Notes -Consult the release notes for important changes. +Consult the release notes for important changes. ## Requirements -Flow depends on Akka 2.4 and requires a Java runtime version of 1.8. It is released for Scala binary versions 2.11 and 2.12.0-M5. +Flow depends on Akka 2.4 and requires a Java runtime version of 1.8. It is released for Scala binary versions 2.11 and 2.12. ## Previous Versions -Archived releases are available in GitHub releases. +Archived releases are available in GitHub releases. diff --git a/index.html b/index.html index 4ae3c84..c7c28e3 100644 --- a/index.html +++ b/index.html @@ -17,7 +17,7 @@ layout: page-full

Getting Started

-

Have a look at the example below to get a feel of flow's usage, then follow the first steps of the user guide.

+

Have a look at the example below to get a feel of akka-serial's usage, then follow the first steps of the user guide.

@@ -30,7 +30,7 @@ layout: page-full {% include_relative _snippet.md %} -

More examples on flow's usage are available in the flow-samples source directory.

+

More examples on akka-serial's usage are available in the samples source directory.