Added API documentation

Author: dcf21

README.md

@@ -0,0 +1,55 @@
+# JSPlot
+
+JSPlot is an open-source Javascript graph-plotting and vector-graphics library, designed for embedding scientific charts
+in websites.
+
+The full source code is available in this GitHub repository, in the `src` directory.
+A [gallery of example plots](https://jsplot.dcford.org.uk/demos.php), together
+with [API documentation](https://jsplot.dcford.org.uk/documentation.php) is available on
+the [JSPlot website](https://jsplot.dcford.org.uk/). A minified version of the source code is available
+here: https://jsplot.dcford.org.uk/js/jsplot.min.js
+
+### License
+
+This code is distributed under the Gnu General Public License (GPL v3). It is (C)
+Dominic Ford 2019 - 2021.
+
+### Plotting options
+
+JSPlot supports a wide range of 2D and 3D chart types, which are designed to look similar to styles often seen in the
+scientific literature. Supported chart types include scatter charts, line charts, bar charts, plots with error bars, and
+more. Data can be either numerical or time stamps, making it easy to plot time-series data along axes which
+automatically render dates and times into an appropriate format.
+
+Options are provided to make plots either static or interactive. In the latter case, the user can click and drag plots
+to scroll the axes or use the mouse wheel to zoom in/out. Such interactive charts are fully compatible with touch-screen
+devices, where pinch gestures are used to zoom.
+
+Supported output media include HTML5 canvas objects, PNG files, and SVG files.
+
+### Directory structure
+
+Within this repository, the code is stored in the following directories:
+
+`src` – This contains all the Javascript source code for JSPlot.
+
+`website` – This contains the PHP source code for the [JSPlot website](https://jsplot.dcford.org.uk/), including
+all the example plots.
+
+`build` – This contains a Python 3 script to build the example website into a form which can be served by an http
+server such as Apache. It compiles the LESS style files into regular CSS, and minifies the Javascript sources into a
+single file. It creates a directory `dist` containing the built website.
+
+### Dependencies
+
+JSPlot requires `jQuery`.
+
+If you wish to build the example website (note that this is not necessary to run JSPlot), you will need to
+install `Python 3`, `nodejs`, `bower`, `uglify-js`, `less`, `less-plugin-clean-css`. The latter four packages can be
+installed via the node package manager (`npm`) as follows:
+
+`npm install -g bower uglify-js less less-plugin-clean-css`
+
+## Author
+
+JSPlot was written by [Dominic Ford](https://dcford.org.uk/) 2019-2021.

build/build.py

@@ -29,7 +29,7 @@
 import php_preprocess
 
 # Flag to choose whether we minify CSS and Javascript
-minify = False
+minify = True
 
 # These subdirectories get symlinked rather than copies, because they're quite big
 symlinkDirectories = ['vendor']

website/css/style.less

@@ -36,7 +36,7 @@
 h2 { margin:12px 0; border-bottom: 1px solid #aaa; padding: 4px 0; }
 h3 { padding: 30px 0 10px 0; font-size:20px; color:#888; border-bottom: 1px solid #ddd; clear: both; }
 h4 { padding-top: 30px; }
-h5 { padding-top: 20px; color: #777; font-size:19px; font-weight: normal; }
+h5 { margin: 30px 0 20px 0; font-size:19px; font-weight: bold; }
 
 h3 a { color: @dark_purple; font-weight: bold; }
 
@@ -51,6 +51,17 @@ table.padded-table td { padding: 5px; }
 table.stripy thead { font-weight: bold; background-color: #ffffff; text-align: center; }
 table.stripy tbody tr:nth-child( odd) { background-color: #e8e8e8; }
 
+table.bordered { border: 2px solid #888888; border-collapse:collapse; }
+table.bordered2 { border-top: 0; }
+table.bordered thead td { border: 1px solid #888888; }
+table.bordered td { border-left: 1px solid #888888; border-right: 1px solid #888888; border-top: 0; border-bottom: 0; padding: 8px 6px; }
+
+table.bordered_slim td { padding: 2px 6px; }
+
+table.api_ref { font-size: 15px; margin: 25px 0; }
+table.api_ref td:nth-child(2) { max-width: 240px; }
+
+
 .btn {
     margin: 15px 8px;
 }