aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Odersky <jodersky@gmail.com>2015-12-16 22:27:31 -0800
committerJakob Odersky <jodersky@gmail.com>2015-12-16 22:27:31 -0800
commitc85028ba87bcde03a3a67b7404a64423dd3e1307 (patch)
treea57e578a811d8100f64f57cf0275478fc456190d
parent7453888b0188a2aeff06b8e9893118b889f8d828 (diff)
downloadakka-serial-c85028ba87bcde03a3a67b7404a64423dd3e1307.tar.gz
akka-serial-c85028ba87bcde03a3a67b7404a64423dd3e1307.tar.bz2
akka-serial-c85028ba87bcde03a3a67b7404a64423dd3e1307.zip
unstructure downloads
-rw-r--r--site/jekyll/_data/current.json8
-rw-r--r--site/jekyll/_data/releases/current.json67
-rw-r--r--site/jekyll/_data/releases/previous/2.3.json54
-rw-r--r--site/jekyll/documentation/manual.md8
-rw-r--r--site/jekyll/downloads/index.md78
5 files changed, 90 insertions, 125 deletions
diff --git a/site/jekyll/_data/current.json b/site/jekyll/_data/current.json
new file mode 100644
index 0000000..5fee025
--- /dev/null
+++ b/site/jekyll/_data/current.json
@@ -0,0 +1,8 @@
+{
+ "version": "2.4.0-RC1",
+ "native_version": {
+ "major": "3",
+ "minor": "0",
+ "patch": "1"
+ }
+}
diff --git a/site/jekyll/_data/releases/current.json b/site/jekyll/_data/releases/current.json
deleted file mode 100644
index 1f3fc45..0000000
--- a/site/jekyll/_data/releases/current.json
+++ /dev/null
@@ -1,67 +0,0 @@
-{
- "version": "2.4.0-RC1",
- "native_version": {
- "major": "3",
- "minor": "0",
- "patch": "1"
- },
- "downloads":[
- {
- "name": "Main Jar",
- "links": [
- {
- "name": ".jar (scala 2.11)",
- "url": "https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow_2.11/2.4.0-RC1/flow_2.11-2.4.0-RC1.jar"
- },
- {
- "name": ".asc (signature)",
- "url": "https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow_2.11/2.4.0-RC1/flow_2.11-2.4.0-RC1.jar.asc"
- }
- ]
- },
- {
- "name": "Native Jar",
- "links": [
- {
- "name": ".jar",
- "url" : "https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow-native/2.4.0-RC1/flow-native-2.4.0-RC1.jar"
- },
- {
- "name": ".asc (signature)",
- "url" : "https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow-native/2.4.0-RC1/flow-native-2.4.0.jar-RC1.asc"
- }
- ]
- },
- {
- "name": "Native Libraries",
- "links": [
- {
- "name": ".tar.gz",
- "url" : "https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow-native/2.4.0-RC1/flow-native-2.4.0-RC1.jar"
- },
- {
- "name": ".asc (signature)",
- "url" : "https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow-native/2.4.0-RC1/flow-native-2.4.0.jar-RC1.asc"
- }
- ]
- }
- ],
- "platforms":[
- {
- "arch":"x86_64",
- "kernel":"Linux"
- },
- {
- "arch":"i686",
- "kernel":"Linux"
- },
- {
- "arch":"armv7l",
- "kernel":"Linux"
- },
- {
- "arch":"x86_64",
- "kernel":"Darwin (Mac OSX)"
- }
- ]
-}
diff --git a/site/jekyll/_data/releases/previous/2.3.json b/site/jekyll/_data/releases/previous/2.3.json
deleted file mode 100644
index 68414db..0000000
--- a/site/jekyll/_data/releases/previous/2.3.json
+++ /dev/null
@@ -1,54 +0,0 @@
-{
- "version": "2.3.1",
- "native_version": {
- "major": "3",
- "minor": "0",
- "patch": "1"
- },
- "downloads":[
- {
- "name": "Main Jar",
- "links": [
- {
- "name": ".jar (scala 2.11)",
- "url": "https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow_2.11/2.3.1/flow_2.11-2.3.1.jar"
- },
- {
- "name": ".asc (signature)",
- "url": "https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow_2.11/2.3.1/flow_2.11-2.3.1.jar.asc"
- }
- ]
- },
- {
- "name": "Native Jar",
- "links": [
- {
- "name": ".jar",
- "url" : "https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow-native/2.3.1/flow-native-2.3.1.jar"
- },
- {
- "name": ".asc (signature)",
- "url" : "https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow-native/2.3.1/flow-native-2.3.1.jar.asc"
- }
- ]
- }
- ],
- "platforms":[
- {
- "arch":"x86_64",
- "kernel":"Linux"
- },
- {
- "arch":"i686",
- "kernel":"Linux"
- },
- {
- "arch":"armv7l",
- "kernel":"Linux"
- },
- {
- "arch":"x86_64",
- "kernel":"Darwin (MacOSX)"
- }
- ]
-}
diff --git a/site/jekyll/documentation/manual.md b/site/jekyll/documentation/manual.md
index 547963c..918f206 100644
--- a/site/jekyll/documentation/manual.md
+++ b/site/jekyll/documentation/manual.md
@@ -10,7 +10,7 @@ layout: page
Flow uses SBT as build system. To get started, include a dependency to flow in your project:
~~~scala
-libraryDependencies += "com.github.jodersky" %% "flow" % "{{site.data.releases.current.version}}"
+libraryDependencies += "com.github.jodersky" %% "flow" % "{{site.data.current.version}}"
~~~
Next, you need to include flow's native library that supports communication for serial devices.
@@ -28,18 +28,18 @@ It is recommended that you use the first option for testing purposes or end-user
In case your OS/architecture combination is present in the "supported platforms" table in the downloads section, add a second dependency to your project:
~~~scala
-libraryDependencies += "com.github.jodersky" % "flow-native" % "{{site.data.releases.current.version}}" % "runtime"
+libraryDependencies += "com.github.jodersky" % "flow-native" % "{{site.data.current.version}}" % "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.
### Maximum Portability
-First, obtain a copy of the native library, either by [building flow](#building-from-source) or by [downloading]({{site.url}}/downloads) a precompiled version. In order to work with this version of flow, native libraries need to be of major version {{site.data.releases.current.native_version.major}} and minor version greater or equal to {{site.data.releases.current.native_version.minor}}.
+First, obtain a copy of the native library, either by [building flow](#building-from-source) or by [downloading]({{site.url}}/downloads) a precompiled version. In order to work with this version of flow, native libraries need to be of major version {{site.data.current.native_version.major}} and minor version greater or equal to {{site.data.current.native_version.minor}}.
Second, for every end-user application that relies on flow, manually add the native library for the current platform to the JVM's library path. This can be achieved through various ways, notably:
- Per application:
- Run your program with the command-line option ```-Djava.library.path=".:<folder containing libflow{{site.data.releases.current.native_version.major}}.so>"```. E.g. ```java -Djava.library.path=".:/home/<folder containing libflow{{site.data.releases.current.native_version.major}}.so>" -jar your-app.jar```
+ Run your program with the command-line option ```-Djava.library.path=".:<folder containing libflow{{site.data.current.native_version.major}}.so>"```. E.g. ```java -Djava.library.path=".:/home/<folder containing libflow{{site.data.current.native_version.major}}.so>" -jar your-app.jar```
- System- or user-wide:
diff --git a/site/jekyll/downloads/index.md b/site/jekyll/downloads/index.md
new file mode 100644
index 0000000..55e6791
--- /dev/null
+++ b/site/jekyll/downloads/index.md
@@ -0,0 +1,78 @@
+---
+layout: page
+title: Downloads
+---
+
+## Latest Version <small>{{site.data.current.version}}</small>
+
+{::options parse_block_html="true" /}
+<div class="row">
+
+<div class="col-sm-8">
+### Sbt Coordinates :
+Add the following tothe build configuration:
+
+~~~scala
+//main artifact
+libraryDependencies += "com.github.jodersky" %% "flow" % "{{site.data.current.version}}"
+
+//(optional) "fat" jar containing native libraries
+libraryDependencies += "com.github.jodersky" % "flow-native" % "{{site.data.current.version}}" % "runtime"
+~~~
+
+### Archives
+
+- Main Jar
+[.jar (scala 2.11)](https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow_2.11/2.4.0-RC1/flow_2.11-2.4.0-RC1.jar)
+[.asc (signature)](https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow_2.11/2.4.0-RC1/flow_2.11-2.4.0-RC1.jar.asc)
+
+- Native Jar
+[.jar](https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow-native/2.4.0-RC1/flow-native-2.4.0-RC1.jar)
+[.asc (signature)](https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow-native/2.4.0-RC1/flow-native-2.4.0-RC1.jar.asc)
+
+</div>
+
+<div class="col-sm-4">
+### Supported Platforms*
+
+<table class="table">
+ <thead>
+ <tr>
+ <th>Kernel</th><th>Architecture</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr><td rowspan="3">Linux</td><td>x86_64</td></tr>
+ <tr><td>x86</td></tr>
+ <tr><td>armv7l</td></tr>
+ <tr><td>Darwin (Mac OSX)</td><td>x86_64</td></tr>
+ </tbody>
+</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>
+</div>
+
+</div>
+
+## Release Notes
+Consult the <a href="https://github.com/jodersky/flow/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.
+
+## Previous Versions
+
+### 2.3.1
+
+- Main Jar
+[.jar (scala 2.11)](https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow_2.11/2.3.1/flow_2.11-2.3.1.jar)
+[.asc (signature)](https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow_2.11/2.3.1/flow_2.11-2.3.1.jar.asc)
+
+- Native Jar
+[.jar](https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow-native/2.3.1/flow-native-2.3.1.jar)
+[.asc (signature)](https://bintray.com/artifact/download/jodersky/maven/com/github/jodersky/flow-native/2.3.1/flow-native-2.3.1.jar.asc)
+
+
+### Older Releases
+Archived releases are available in <a href="https://github.com/jodersky/flow/releases">GitHub releases</a>.