aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Odersky <jakob@odersky.com>2017-01-15 20:03:37 -0800
committerJakob Odersky <jakob@odersky.com>2017-01-15 20:03:55 -0800
commita123bd8dbb98587bbc59535ea9155fefaaf828a1 (patch)
tree418dbf0e23235c35d2bdfc4b83b2dc7c4ed2aaac
parentd88a6f18d491e1bf55635023e5cd977226a3db7b (diff)
downloadakka-serial-a123bd8dbb98587bbc59535ea9155fefaaf828a1.tar.gz
akka-serial-a123bd8dbb98587bbc59535ea9155fefaaf828a1.tar.bz2
akka-serial-a123bd8dbb98587bbc59535ea9155fefaaf828a1.zip
Rename project
-rw-r--r--_config.yml6
-rw-r--r--_includes/header.html5
-rw-r--r--_snippet.md2
-rw-r--r--assets/images/logo.pngbin3207 -> 0 bytes
-rw-r--r--assets/images/logo.svg70
-rw-r--r--documentation/3.0/manual.md14
-rw-r--r--documentation/index.md32
-rw-r--r--downloads/index.md20
-rw-r--r--index.html4
9 files changed, 41 insertions, 112 deletions
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 @@
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="{{site.url}}">
- <img src="{{site.url}}/assets/images/logo.png" alt="flow logo">
- flow
+ akka-serial
</a>
</div>
<ul class="nav navbar-nav navbar-right">
<li><a href="{{site.url}}/documentation">Documentation & Help</a></li>
<li><a href="{{site.url}}/downloads">Download</a></li>
- <li><a href="https://github.com/jodersky/flow">GitHub</a></li>
+ <li><a href="https://github.com/jodersky/akka-serial">GitHub</a></li>
</ul>
</div>
</nav>
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
--- a/assets/images/logo.png
+++ /dev/null
Binary files 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 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!-- Created with Inkscape (http://www.inkscape.org/) -->
-
-<svg
- xmlns:dc="http://purl.org/dc/elements/1.1/"
- xmlns:cc="http://creativecommons.org/ns#"
- xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns="http://www.w3.org/2000/svg"
- xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
- xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
- width="56.444443mm"
- height="18.517235mm"
- viewBox="0 0 199.99999 65.612249"
- id="svg2"
- version="1.1"
- inkscape:version="0.91 r13725"
- sodipodi:docname="logo.svg"
- inkscape:export-filename="/home/jodersky/projects/flow/flow/site/jekyll/assets/images/flow.png"
- inkscape:export-xdpi="90"
- inkscape:export-ydpi="90">
- <defs
- id="defs4" />
- <sodipodi:namedview
- id="base"
- pagecolor="#ffffff"
- bordercolor="#666666"
- borderopacity="1.0"
- inkscape:pageopacity="0.0"
- inkscape:pageshadow="2"
- inkscape:zoom="0.98994949"
- inkscape:cx="291.06408"
- inkscape:cy="105.15685"
- inkscape:document-units="px"
- inkscape:current-layer="layer1"
- showgrid="false"
- inkscape:window-width="1920"
- inkscape:window-height="1034"
- inkscape:window-x="0"
- inkscape:window-y="27"
- inkscape:window-maximized="1"
- fit-margin-top="0"
- fit-margin-left="0"
- fit-margin-right="0"
- fit-margin-bottom="0" />
- <metadata
- id="metadata7">
- <rdf:RDF>
- <cc:Work
- rdf:about="">
- <dc:format>image/svg+xml</dc:format>
- <dc:type
- rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
- <dc:title></dc:title>
- </cc:Work>
- </rdf:RDF>
- </metadata>
- <g
- inkscape:label="Layer 1"
- inkscape:groupmode="layer"
- id="layer1"
- transform="translate(2.4941306e-8,-986.74997)">
- <path
- style="fill:none;fill-rule:evenodd;stroke:#2a2aff;stroke-width:6.52591991;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
- d="m 3.2886017,1017.8164 c 69.4236103,105.8065 117.7061283,-98.84851 193.4200483,0"
- id="path3336"
- inkscape:connector-curvature="0"
- sodipodi:nodetypes="cc" />
- </g>
-</svg>
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.
- <i class="fa fa-book"></i> [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.
-- <i class="fa fa-book"></i> [Examples](https://github.com/jodersky/flow/tree/master/flow-samples)
+- <i class="fa fa-book"></i> [Examples](https://github.com/jodersky/akka-serial/tree/master/samples)
See some very simple, working demo applications.
- <i class="fa fa-book"></i> [Developer Guide]({{site.version_docs}}/developer)
- Instructions on building, testing and publishing flow.
+ Instructions on building, testing and publishing akka-serial.
-- <i class="fa fa-code"></i> [API documentation]({{site.version_docs}}/api/index.html#ch.jodersky.flow.Serial$)
- Browse flow's API.
+- <i class="fa fa-code"></i> [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.
-- <i class="fa fa-bug"></i> [Issues](https://github.com/jodersky/flow/issues)
+- <i class="fa fa-bug"></i> [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.
-- <i class="fa fa-comments"></i> [Chat](https://gitter.im/jodersky/flow)
+- <i class="fa fa-comments"></i> [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}}"
~~~
</div>
@@ -43,16 +43,16 @@ libraryDependencies += "ch.jodersky" %% "flow-stream" % "{{site.version_latest}}
</table>
<p class="small">*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.</p>
+akka-serial is POSIX compatible so it can be built for a lot more platforms.</p>
</div>
</div>
## Release Notes
-Consult the <a href="https://github.com/jodersky/flow/blob/master/CHANGELOG.md">release notes</a> for important changes.
+Consult the <a href="https://github.com/jodersky/akka-serial/blob/master/CHANGELOG.md">release notes</a> 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 <a href="https://github.com/jodersky/flow/releases">GitHub releases</a>.
+Archived releases are available in <a href="https://github.com/jodersky/akka-serial/releases">GitHub releases</a>.
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
</div>
<div class="col-sm-6">
<h2>Getting Started</h2>
- <p>Have a look at the example below to get a feel of flow's usage, then follow the first steps of the <a href="documentation/{{site.version_docs}}/manual">user guide</a>.</p>
+ <p>Have a look at the example below to get a feel of akka-serial's usage, then follow the first steps of the <a href="documentation/{{site.version_docs}}/manual">user guide</a>.</p>
</div>
</div>
</div>
@@ -30,7 +30,7 @@ layout: page-full
{% include_relative _snippet.md %}
</div>
</div>
- <p>More examples on flow's usage are available in the <a href="https://github.com/jodersky/flow/tree/master/flow-samples">flow-samples</a> source directory.</p>
+ <p>More examples on akka-serial's usage are available in the <a href="https://github.com/jodersky/akka-serial/tree/master/samples">samples</a> source directory.</p>
</div>
<footer style="text-align: center;">