update documentation

Contributing to FnordMetric

===========================

Contributing to PlotFX

======================

To contribute, please fork the github repository, make your changes and run the 

specs, commit them to your github repository and send me a pull request.

Need help, head on over to our [Google Groups][1] page to discuss any ideas

that you might have.

### Ways to contribute to FnordMetric:

Here are some ways to contribute to PlotFX:

  + report bugs or suggest new features

  + suggest or implement new options for existing charts or new chart types

  + improve the documentation

  + publish howtos, tutorials and videos

  + add a new backend (requires c++ knowledge)

  + add a new render target (requires c++ knowledge)

  + many more! improve all the things :)

  + Report bugs or suggest new features

  + Suggest or implement new options for existing charts or new chart types

  + Improve the documentation

  + Publish howtos, tutorials and videos

#### Individual Contributors to FnordMetric

## Individual Contributors to PlotFX

+ Laura Schlimmer (http://github.com/lauraschlimmer)

+ Christian Parpart (http://github.com/trapni)

+ Finn Zirngibl (https://github.com/finnomenon)

+ Simon Menke (http://github.com/fd)

+ Bruno Michel (http://github.com/nono)

+ Marco Borromeo (http://github.com/mborromeo)

+ Leo Lou (http://github.com/l4u)

+ Andy Lindeman (http://github.com/alindeman)

+ Jurriaan Pruis (http://github.com/jurriaan)

+ Kacper Bielecki (http://github.com/kazjote)

+ John Murray (http://github.com/JohnMurray)

+ Lars Gierth (http://github.com/lgierth)

+ Ross Kaffenberger (http://github.com/rossta)

+ Kunal Modi (http://github.com/kunalmodi)

+ Michael Fairchild (http://github.com/fairchild)

+ James Cox (http://github.com/imajes)

+ Pieter Noordhuis (http://github.com/pietern)

+ Tadas Ščerbinskas (http://github.com/tadassce)

+ Sebastian Korfmann (http://github.com/skorfmann)

+ Paul Asmuth (http://github.com/paulasmuth)

[View the list of individual contributors on Github](http://github.com/plotfx/plotfx/graphs/contributors)

[http://github.com/paulasmuth/fnordmetric/graphs/contributors](http://github.com/paulasmuth/fnordmetric/graphs/contributors)

#### Other Open Source Software included in FnordMetric

  + Marijn Haverbeke's CodeMirror --- javascript code editor (https://github.com/marijnh/codemirror)

  + FontAwesome --- icon font (http://fontawesome.io/)

### Compile from source

You need autotools and a modern c++ compiler. To compile fnordmetric from a git

checkout run:

To build PlotFX, you need an up-to-date C++ compiler, cmake, libharfbuzz and

libfreetype. Run:

    $ git clone https://github.com/paulasmuth/fnordmetric.git && cd fnordmetric

    $ ./autogen.sh

    $ ./configure

    $ git clone git@github.com:plotfx/plotfx.git

    $ cd plotfx

    $ cmake .

    $ make

    $ sudo make install

To install the `plotfx` binary into your system, run `make install`:

    $ make install

To run the test suite, run `make test`:

    $ make test

# PlotFX v0.1.0

PlotFX is a collection of lightweight tools for real-time metrics collection

and visualization with SQL. The tools allow you to record measurements and

build beautiful real-time dashboards within minutes. All using your favorite SQL

database (currently supported are MySQL, Postgres and EventQL).

<ul>

  <li>

    <h4 style="margin-bottom:.2em; font-size:16px;"><a href="/documentation/metric-collectd">metric-collectd</a></h4>

    <p>

      metric-collectd is a lightweight daemon that collects measurements and other

      timeseries data, pre-aggregates it and stores the resulting tuples into a

      backend database. metric-collectd can currently listen for samples in

      Text/StatsD or JSON format via UDP or HTTP. It can also pull samples via

      HTTP or SNMP.

    </p>

  </li>

  <li>

    <h4 style="margin-bottom:.2em; font-size:16px;"><a href="/documentation/metric-queryd">metric-queryd</a></h4>

    <p>

      metric-queryd is a simple HTTP service that executes SQL queries on a backend

      database and plots the results. The HTTP API allows you to create timeseries graphs

      and other visualizations using nothing but SQL. You can easily plug the returned

      charts into a HTML site to create a real-time SQL-powered dashboard.

    </p>

  </li>

</ul>

The two services, `metricd-collectd` and `metric-queryd` do not depend on each

other and don't share a lot of code. If you're only interested in the data capture

part or only in the visualization part, you can run only one of the services.

To get started with PlotFX, have a look at these pages:

[Getting Started](/documentation/getting-started),

[Data Model](/documentation/data-model)

PlotFX is a command line tool for creating charts from CSV files. It supports a

number of different plot types and other diagrams. Charts can be customized

using a configuration language similar to CSS.

<div class="notice">

  <div style="float:right;"><a class="github-button" data-style="mega" href="https://github.com/paulasmuth/fnordmetric" data-count-href="/paulasmuth/fnordmetric/stargazers" data-count-api="/repos/paulasmuth/fnordmetric#stargazers_count" data-count-aria-label="# stargazers on GitHub" aria-label="Star paulasmuth/fnordmetric on GitHub">View on GitHub</a></div>

  <div style="float:right;"><a class="github-button" data-style="mega" href="https://github.com/plotfx/plotfx" data-count-href="/plotfx/plotfx/stargazers" data-count-api="/repos/plotfx/plotfx#stargazers_count" data-count-aria-label="# stargazers on GitHub" aria-label="Star plotfx/plotfx on GitHub">View on GitHub</a></div>

  Join PlotFX development now on GitHub. We're always appreciating new pull requests, bugs and feature requests!

</div>

## Examples

## Getting Started

Here are some example charts that were generated using `metric-queryd` and SQL to

give you some ideas on what is possible. Have a look at the

[full list of examples](/examples/) for more.

[![A simple line chart](./examples/linecharts/lines_with_points.svg)](./examples/linecharts/lines_with_points.plot)

<div style="height: .6em;"></div>

The simple line chart from above was generated with PlotFX using the following

command line:

_Example: Simple timeseries chart_

<a href="/examples/linecharts/simple_lines"><img src="/examples/linecharts/simple_lines/simple_lines.png" style="width: 100%;" /></a>

    $ plotfx -in example_chart.plot -out example_chart.svg

_Example: Chart with explicit domain and legend_

<a href="/examples/linecharts/explicit_domain"><img src="/examples/linecharts/explicit_domain/explicit_domain.png" style="width: 100%;" /></a>

Running the command from above, will generate the following output file

(`example_chart.svg`):

_Example: Horizontal barchart_

<a href="/examples/barcharts/horizontal_bars"><img src="/examples/barcharts/horizontal_bars/horizontal_bars.png" style="width: 100%;" /></a>

Input File (`example_chart.plot`):

_Example: Scatter chart with lables_

<a href="/examples/pointcharts/pointchart_with_labels"><img src="/examples/pointcharts/pointchart_with_labels/pointchart_with_labels.png" style="width: 100%;" /></a>

    plot {

      axis-top: off;

      axis-right: off;

## Getting Started

      ymin: -10;

      ymax: 32;

      series {

        title: "New York";

        point-size: 3.3pt;

        xs: csv(testdata/city_temperatures.csv, month);

        ys: csv(testdata/city_temperatures.csv, new_york);

      }

      series {

        title: "北京市";

        point-size: 3.3pt;

        xs: csv(testdata/city_temperatures.csv, month);

        ys: csv(testdata/city_temperatures.csv, beijing);

      }

      # ...

    }

For more examples, please see [the examples page](https://github.com/plotfx/plotfx/tree/master/examples).

To get started with PlotFX, have a look at the [Getting Started](/documentation/getting-started) and

[Data Model](/documentation/data-model) pages. If you have any questions please

don't hesitate to reach out via [Github Issues](http://github.com/paulasmuth/fnordmetric/issues)

don't hesitate to reach out via [Github Issues](http://github.com/plotfx/plotfx/issues)

or [the PlotFX google group](http://groups.google.com/group/fnordmetric).

## More Examples

Here are some example charts that were generated using `plotfx` to give you some

ideas on what is possible. Have a look at the [full list of examples](/examples/)

for more.

<div style="height: .6em;"></div>

_Example: Simple timeseries chart_

<a href="/examples/linecharts/simple_lines"><img src="/examples/areacharts/examples_simple_lines.png" style="width: 100%;" /></a>

_Example: Chart with explicit domain and legend_

<a href="/examples/linecharts/explicit_domain"><img src="/examples/linecharts/examples_explicit_domain.png" style="width: 100%;" /></a>

_Example: Horizontal barchart_

<a href="/examples/barcharts/horizontal_bars"><img src="/examples/barcharts/examples_horizontal_bars.png" style="width: 100%;" /></a>

_Example: Scatter chart with lables_

<a href="/examples/pointcharts/pointchart_with_labels"><img src="/examples/pointcharts/examples_pointchart_with_labels.png" style="width: 100%;" /></a>

<script async defer src="https://buttons.github.io/buttons.js"></script>

License

=======

Copyright (c) 2018, Paul Asmuth, Laura Schlimmer

The PlotFX License (https://plotfx.org)

Copyright (c) 2018, Paul Asmuth, Laura Schlimmer<br />

All rights reserved.

Redistribution and use in source and binary forms, with or without

Support

=======

There are various ways to get support for FnordMetric:

There are various ways to get support for PlotFX:

+ [Github Issues](http://github.com/paulasmuth/fnordmetric/issues)

+ [The FnordMetric Google Group](http://groups.google.com/group/fnordmetric)

+ [The PlotFX Google Group](http://groups.google.com/group/fnordmetric)