Commit 1c6ac3b4 authored by Paul Asmuth's avatar Paul Asmuth
Browse files

update readme

parent 9c46a61a
Loading
Loading
Loading
Loading
+25 −3
Original line number Diff line number Diff line
@@ -4,9 +4,22 @@ PlotFX
[![Build Status](https://img.shields.io/travis/plotfx/plotfx/master.svg?style=flat-square)](http://travis-ci.org/plotfx/plotfx)
![BSD-License](https://img.shields.io/badge/license-BSD-blue.svg?style=flat-square)

`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.
`plotfx` is a command line tool for creating charts and other data-driven
visualizations. It is partially based on ideas from the "Grammar of Graphics" and
the ggplot2 R library. One of the main goals for PlotFX is that using it should be
simple and fun.

PlotFX is a standalone tool - it is not required to know any specific programming
language to use it. Charts are specified using a lightweight syntax that is very
similar to CSS and input data is usually read from CSV files.

You can run PlotFX from the command line, where it generates SVG, PNG and PDF
output files. Additionally, you can embed it into your own application using the
C API.

**WARNING**: The project is currently a work-in-progress. I'm currently working
on removing the old SQL chart specification language and replacing it with the
new CSS-like syntax. This might take a while...

[Examples](https://github.com/plotfx/plotfx/tree/master/examples) |
[Documentation](https://plotfx.org/)
@@ -111,6 +124,15 @@ Here are some more examples of plots generated by PlotFX:
For more examples, please see [the examples page](https://github.com/plotfx/plotfx/tree/master/examples).


Acknowledgements
----------------

PlotFX is the successor of the FnordMetric ChartSQL project by the same authors.

Parts of the new chart specification syntax and semantics were inspired by ideas
from the "Grammar of Graphics" and the ggplot2 project.


License
-------