aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJosé Bollo <jose.bollo@iot.bzh>2016-06-24 16:19:36 +0200
committerJosé Bollo <jose.bollo@iot.bzh>2016-06-24 16:20:27 +0200
commit836b3c0b74accc5494d7877a22b4a45b5450b6f3 (patch)
tree2f67e08d17e9dc2c135ebae92e438e251cae68ad /doc
parentf2584b67445ca63d3ec8e4a11202a19250434fc8 (diff)
improves doc for new usages
Change-Id: Idb1ae01484d1181904e91d57abafe7bdb8230179 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'doc')
-rw-r--r--doc/FAQ.html5
-rw-r--r--doc/FAQ.md4
-rw-r--r--doc/README.html32
-rw-r--r--doc/README.md12
-rw-r--r--doc/afb-application-writing.html5
-rw-r--r--doc/afb-application-writing.md6
-rw-r--r--doc/afb-bindings-overview.html5
-rw-r--r--doc/afb-bindings-overview.md5
-rw-r--r--doc/afb-bindings-writing.html5
-rw-r--r--doc/afb-bindings-writing.md6
-rw-r--r--doc/afb-daemon-vocabulary.html5
-rw-r--r--doc/afb-daemon-vocabulary.md5
-rw-r--r--doc/afb-overview.html5
-rw-r--r--doc/afb-overview.md6
-rw-r--r--doc/afb-tests-overview.html5
-rw-r--r--doc/afb-tests-overview.md5
-rw-r--r--doc/doc.css2
17 files changed, 14 insertions, 104 deletions
diff --git a/doc/FAQ.html b/doc/FAQ.html
index e5f64273..5cc8b653 100644
--- a/doc/FAQ.html
+++ b/doc/FAQ.html
@@ -16,7 +16,7 @@
<header>
<h1 class="title">Frequently Asked Question about AFB-DAEMON</h1>
<h2 class="author">José Bollo</h2>
-<h3 class="date">10 juin 2016</h3>
+<h3 class="date">24 juin 2016</h3>
</header>
<nav id="TOC">
<ul>
@@ -24,8 +24,5 @@
</ul>
</nav>
<h1 id="frequently-asked-question-about-afb-daemon">Frequently Asked Question about AFB-DAEMON</h1>
-<pre><code>version: 1
-Date: 27 mai 2016
-Author: José Bollo</code></pre>
</body>
</html>
diff --git a/doc/FAQ.md b/doc/FAQ.md
index 7dad1ab2..d485c97e 100644
--- a/doc/FAQ.md
+++ b/doc/FAQ.md
@@ -1,8 +1,6 @@
+
Frequently Asked Question about AFB-DAEMON
==========================================
- version: 1
- Date: 27 mai 2016
- Author: José Bollo
diff --git a/doc/README.html b/doc/README.html
deleted file mode 100644
index 837505ae..00000000
--- a/doc/README.html
+++ /dev/null
@@ -1,32 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
- <meta charset="utf-8">
- <meta name="generator" content="pandoc">
- <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
- <title>### Inititial Build</title>
- <style type="text/css">code{white-space: pre;}</style>
- <!--[if lt IE 9]>
- <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link rel="stylesheet" href="doc.css">
-</head>
-<body>
-<header>
-<h1 class="title">### Inititial Build</h1>
-</header>
-<nav id="TOC">
-<ul>
-<li><a href="#inititial-build">Inititial Build</a></li>
-<li><a href="#netbeans">Netbeans</a></li>
-<li><a href="#copy-nbprojet-at-project-base">Copy nbprojet at project base</a></li>
-</ul>
-</nav>
-<p>mkdir build cd build cmake .. ### Netbeans % Fulup Ar Foll % 14 décembre 2015</p>
-<h3 id="inititial-build">Inititial Build</h3>
-<p>mkdir build cd build cmake ..</p>
-<h3 id="netbeans">Netbeans</h3>
-<h1 id="copy-nbprojet-at-project-base">Copy nbprojet at project base</h1>
-<p>cp -r doc/nbproject.template ./nbproject</p>
-</body>
-</html>
diff --git a/doc/README.md b/doc/README.md
deleted file mode 100644
index d5c047cb..00000000
--- a/doc/README.md
+++ /dev/null
@@ -1,12 +0,0 @@
-
-### Inititial Build
-
-mkdir build
-cd build
-cmake ..
-
-
-### Netbeans
-
-# Copy nbprojet at project base
-cp -r doc/nbproject.template ./nbproject
diff --git a/doc/afb-application-writing.html b/doc/afb-application-writing.html
index ad1911df..12a2f13f 100644
--- a/doc/afb-application-writing.html
+++ b/doc/afb-application-writing.html
@@ -37,7 +37,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
<h1 class="title">HOWTO WRITE an APPLICATION above AGL FRAMEWORK</h1>
<h2 class="author">José Bollo</h2>
<h2 class="author">Fulup Ar Foll</h2>
-<h3 class="date">10 juin 2016</h3>
+<h3 class="date">24 juin 2016</h3>
</header>
<nav id="TOC">
<ul>
@@ -68,9 +68,6 @@ code > span.er { color: #ff0000; font-weight: bold; }
</ul>
</nav>
<h1 id="howto-write-an-application-above-agl-framework">HOWTO WRITE an APPLICATION above AGL FRAMEWORK</h1>
-<pre><code>version: 1
-Date: 09 juin 2016
-Author: José Bollo</code></pre>
<h2 id="programmation-languages-for-applications">Programmation Languages for Applications</h2>
<h3 id="writing-an-html5-application">Writing an HTML5 application</h3>
<p>Developers of HTML5 applications (client side) can easily create applications for AGL framework using their preferred HTML5 framework.</p>
diff --git a/doc/afb-application-writing.md b/doc/afb-application-writing.md
index 772d9914..14199f62 100644
--- a/doc/afb-application-writing.md
+++ b/doc/afb-application-writing.md
@@ -1,10 +1,6 @@
+
HOWTO WRITE an APPLICATION above AGL FRAMEWORK
==============================================
- version: 1
- Date: 09 juin 2016
- Author: José Bollo
-
-
Programmation Languages for Applications
-----------------------------------------
diff --git a/doc/afb-bindings-overview.html b/doc/afb-bindings-overview.html
index b731aff2..b650860c 100644
--- a/doc/afb-bindings-overview.html
+++ b/doc/afb-bindings-overview.html
@@ -16,7 +16,7 @@
<header>
<h1 class="title">Overview of bindings shipped with AFB-Daemon</h1>
<h2 class="author">José Bollo</h2>
-<h3 class="date">23 juin 2016</h3>
+<h3 class="date">24 juin 2016</h3>
</header>
<nav id="TOC">
<ul>
@@ -34,9 +34,6 @@
</ul>
</nav>
<h1 id="overview-of-bindings-shipped-with-afb-daemon">Overview of bindings shipped with AFB-Daemon</h1>
-<pre><code>Version: 1
-Date: 09 juin 2016
-Author: Manuel Bachmann</code></pre>
<h2 id="list-of-bindings">List of bindings</h2>
<p>Here are the bindings shipped in the source tree:</p>
<ul>
diff --git a/doc/afb-bindings-overview.md b/doc/afb-bindings-overview.md
index 03650cd4..1d3632ee 100644
--- a/doc/afb-bindings-overview.md
+++ b/doc/afb-bindings-overview.md
@@ -1,9 +1,6 @@
+
Overview of bindings shipped with AFB-Daemon
===========================================
- Version: 1
- Date: 09 juin 2016
- Author: Manuel Bachmann
-
List of bindings
---------------
diff --git a/doc/afb-bindings-writing.html b/doc/afb-bindings-writing.html
index 8017e190..20113a70 100644
--- a/doc/afb-bindings-writing.html
+++ b/doc/afb-bindings-writing.html
@@ -35,7 +35,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
<header>
<h1 class="title">HOWTO WRITE a BINDING for AFB-DAEMON</h1>
<h2 class="author">José Bollo</h2>
-<h3 class="date">23 juin 2016</h3>
+<h3 class="date">24 juin 2016</h3>
</header>
<nav id="TOC">
<ul>
@@ -82,9 +82,6 @@ code > span.er { color: #ff0000; font-weight: bold; }
</ul>
</nav>
<h1 id="howto-write-a-binding-for-afb-daemon">HOWTO WRITE a BINDING for AFB-DAEMON</h1>
-<pre><code>version: 1
-Date: 09 juin 2016
-Author: José Bollo</code></pre>
<h2 id="summary">Summary</h2>
<p>Afb-daemon binders serve files through HTTP protocol and offers to developers the capability to expose application API methods through HTTP or WebSocket protocol.</p>
<p>Binder bindings are used to add API to afb-daemon. This part describes how to write a binding for afb-daemon.</p>
diff --git a/doc/afb-bindings-writing.md b/doc/afb-bindings-writing.md
index 9efc5bd3..369c6d72 100644
--- a/doc/afb-bindings-writing.md
+++ b/doc/afb-bindings-writing.md
@@ -1,10 +1,6 @@
+
HOWTO WRITE a BINDING for AFB-DAEMON
===================================
- version: 1
- Date: 09 juin 2016
- Author: José Bollo
-
-
Summary
-------
diff --git a/doc/afb-daemon-vocabulary.html b/doc/afb-daemon-vocabulary.html
index bffe91f6..282be6b4 100644
--- a/doc/afb-daemon-vocabulary.html
+++ b/doc/afb-daemon-vocabulary.html
@@ -16,7 +16,7 @@
<header>
<h1 class="title">Vocabulary for AFB-DAEMON</h1>
<h2 class="author">José Bollo</h2>
-<h3 class="date">23 juin 2016</h3>
+<h3 class="date">24 juin 2016</h3>
</header>
<nav id="TOC">
<ul>
@@ -38,9 +38,6 @@
</ul>
</nav>
<h1 id="vocabulary-for-afb-daemon">Vocabulary for AFB-DAEMON</h1>
-<pre><code>version: 1
-Date: 27 mai 2016
-Author: José Bollo</code></pre>
<h2 id="binding">Binding</h2>
<p>A shared library object intended to be add a functionnality to an afb-daemon instance. It implements an API. It may provide a service.</p>
<p>Binding made for services can have specific entry point called after initialisation and before serving.</p>
diff --git a/doc/afb-daemon-vocabulary.md b/doc/afb-daemon-vocabulary.md
index 0be4e3db..897e4db1 100644
--- a/doc/afb-daemon-vocabulary.md
+++ b/doc/afb-daemon-vocabulary.md
@@ -1,9 +1,6 @@
+
Vocabulary for AFB-DAEMON
=========================
- version: 1
- Date: 27 mai 2016
- Author: José Bollo
-
## Binding
diff --git a/doc/afb-overview.html b/doc/afb-overview.html
index 23ca6e9c..caf11d81 100644
--- a/doc/afb-overview.html
+++ b/doc/afb-overview.html
@@ -16,7 +16,7 @@
<header>
<h1 class="title">Overview of AFB-DAEMON</h1>
<h2 class="author">José Bollo</h2>
-<h3 class="date">23 juin 2016</h3>
+<h3 class="date">24 juin 2016</h3>
</header>
<nav id="TOC">
<ul>
@@ -34,9 +34,6 @@
</ul>
</nav>
<h1 id="overview-of-afb-daemon">Overview of AFB-DAEMON</h1>
-<pre><code>version: 1
-Date: 30 mai 2016
-Author: José Bollo</code></pre>
<h2 id="roles-of-afb-daemon">Roles of afb-daemon</h2>
<p>The name <strong>afb-daemon</strong> stands for <em>Application Framework Binder Daemon</em>. That is why afb-daemon is also named <strong><em>the binder</em></strong>.</p>
<p><strong>Afb-daemon</strong> is in charge to bind one instance of an application to the AGL framework and AGL system.</p>
diff --git a/doc/afb-overview.md b/doc/afb-overview.md
index ab24606c..343a4f30 100644
--- a/doc/afb-overview.md
+++ b/doc/afb-overview.md
@@ -1,10 +1,6 @@
+
Overview of AFB-DAEMON
======================
- version: 1
- Date: 30 mai 2016
- Author: José Bollo
-
-
Roles of afb-daemon
-------------------
diff --git a/doc/afb-tests-overview.html b/doc/afb-tests-overview.html
index b29c1920..549fe492 100644
--- a/doc/afb-tests-overview.html
+++ b/doc/afb-tests-overview.html
@@ -18,7 +18,7 @@
<h1 class="title">Overview of tests shipped with AFB-Daemon</h1>
<h2 class="author">Manuel Bachmann</h2>
<h2 class="author">José Bollo</h2>
-<h3 class="date">23 juin 2016</h3>
+<h3 class="date">24 juin 2016</h3>
</header>
<nav id="TOC">
<ul>
@@ -33,9 +33,6 @@
</ul>
</nav>
<h1 id="overview-of-tests-shipped-with-afb-daemon">Overview of tests shipped with AFB-Daemon</h1>
-<pre><code>Version: 1
-Date: 09 juin 2016
-Author: Manuel Bachmann</code></pre>
<h2 id="list-of-tests">List of tests</h2>
<p>Here are the tests shipped in the source tree:</p>
<ul>
diff --git a/doc/afb-tests-overview.md b/doc/afb-tests-overview.md
index 4fc0c9b2..b70eda12 100644
--- a/doc/afb-tests-overview.md
+++ b/doc/afb-tests-overview.md
@@ -1,9 +1,6 @@
+
Overview of tests shipped with AFB-Daemon
=========================================
- Version: 1
- Date: 09 juin 2016
- Author: Manuel Bachmann
-
List of tests
-------------
diff --git a/doc/doc.css b/doc/doc.css
index 27be9dc7..8c327c09 100644
--- a/doc/doc.css
+++ b/doc/doc.css
@@ -19,8 +19,6 @@ pre {
outline: #555;
}
-pre:first-of-type { width: 20em; }
-
blockquote {
border-left: solid thick black;
background-color: #ff8;