summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/DESCRIPTION.txt5
-rw-r--r--doc/INSTALL.txt8
-rw-r--r--doc/LICENSE.txt23
-rw-r--r--doc/README.txt22
4 files changed, 58 insertions, 0 deletions
diff --git a/doc/DESCRIPTION.txt b/doc/DESCRIPTION.txt
new file mode 100644
index 0000000..0352a21
--- /dev/null
+++ b/doc/DESCRIPTION.txt
@@ -0,0 +1,5 @@
+javascriptRRD
+=============
+
+javascriptRRD is Javascript implementation of a client side RRD tool.
+
diff --git a/doc/INSTALL.txt b/doc/INSTALL.txt
new file mode 100644
index 0000000..30abd35
--- /dev/null
+++ b/doc/INSTALL.txt
@@ -0,0 +1,8 @@
+javascriptRRD installation
+==========================
+
+Being Javascript an interpreted language, no compilation is needed.
+Just copy the files in the files located in the
+src/lib
+directory into a Web accessible location and use them.
+
diff --git a/doc/LICENSE.txt b/doc/LICENSE.txt
new file mode 100644
index 0000000..981625b
--- /dev/null
+++ b/doc/LICENSE.txt
@@ -0,0 +1,23 @@
+javascriptRRD is licensed under the MIT License
+[http://www.opensource.org/licenses/mit-license.php]
+
+Copyright (c) 2009 Frank Wuerthwein, fkw@ucsd.edu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
diff --git a/doc/README.txt b/doc/README.txt
new file mode 100644
index 0000000..9a29d6c
--- /dev/null
+++ b/doc/README.txt
@@ -0,0 +1,22 @@
+javascriptRRD
+=============
+
+javascriptRRD package contains a set of Javascript libraries
+that can be used for reading RRD archives from any Web browser.
+Mozilla, Internet Explorer and Safari hava been tested.
+
+Being Javascript an interpreted language, no compilation is needed.
+Just copy the files in the files located in the
+src/lib
+directory into a Web accessible location and use them.
+
+The
+src/examples/
+directory contain example Web pages that you can use as a template
+for writing your own Web Browser applications for accessing the
+RRD archives on your Web server.
+
+While the code itself tries to be self documenting, the
+doc/lib/
+directory contains more detailed information about the libraries.
+