Commit f426ff15 authored by Paul Asmuth's avatar Paul Asmuth
Browse files

update readme, getting started...

parent 02b2c48b
Loading
Loading
Loading
Loading
+19 −24
Original line number Diff line number Diff line
<h1 align="center">PlotFX - Open-source plotting toolkit</h1>
PlotFX
======

<p align="center">
  <a href="https://github.com/plotfx/plotfx/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-BSD-blue.svg" alt="License: BSD"></a>
  <a href="https://ci.appveyor.com/project/plotfx/plotfx/branch/master"><img src="https://ci.appveyor.com/api/projects/status/8h07x0erafnxsumi/branch/master?svg=true" alt="Build Status"></a>
  <br>
  <br>
  <img src="/examples/other/demo.svg" width="90%">
</p>
PlotFX is a command line tool and library for plotting data. The appearance of
plots can be customized using a lightweight syntax that is very similar to CSS.

<p align="center" width="90%">
  PlotFX is a tool for creating data-driven graphics; it allows you to create
  parametric illustrations such as charts and dashboards using a lightweight
  CSS-like syntax.
</p>
You can run PlotFX from the command line, where it generates SVG, PNG or PDF
output files. Additionally, you can embed it into your own application using the
C API.

<h4 align="center">
<h4>
  <a href="https://plotfx.org/documentation/getting-started">Getting Started</a> &middot;
  <a href="https://plotfx.org/examples">Examples</a> &middot;
  <a href="https://plotfx.org">Documentation</a>
</h4>

<p align="center">
  <br>
  <img src="/examples/other/demo.svg" width="90%">
</p>

Introduction
------------

PlotFX is a tool for creating data-driven graphics; it allows you to create
parametric illustrations such as charts and dashboards using a lightweight
CSS-like syntax.
<p align="center">
  <i>A collection of examples generated with PlotFX.</i>
  <br><br>
</p>

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.

PlotFX is built in the hope that using it will be quick, simple and fun.
Project Status
--------------

**WARNING**: The master branch recently underwent a significant refactoring and the
stability is currently beta/experimental. Maybe not even that. It will take a few
+7 −0
Original line number Diff line number Diff line
Getting Started
===============

Welcome to PlotFX! This page will guide you through creating a simple first plot
and then give you pointers to more in-depth documentation.

manual/gettingstarted.txt

deleted100644 → 0
+0 −77
Original line number Diff line number Diff line
This page will guide you through creating a simple first plot and then give you
pointers to more detailed documentation.


### The first image

A minimal example file for PlotFX is this one:

    width: 1200px;
    height: 600px;

    points {
      xs: 10px 40px;
      ys: 20px 400px;
      colors: #06c #c06;
    }

Save this to `example.ptx` and run it using the command line below:

    plotfx --in example.ptx --out example.svg

If you do that, PlotFX will produce a white 1200x600 pixel image with two coloured
dots:

    [ image ]

It's not the most useful example in the world, but it shows how to run files
through PlotFX and illustrates that PlotFX is in a way more similar to a drawing
tool like Inkscape than to a chart generator.

### Parametric drawing


### Adding a scale, title and legend


### Diving deeper


----

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

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

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

Here is the input file from which the above plot was generated (`example_chart.ptx`):

    width: 1200px;
    height: 280px;

    scale-y-min: 0;
    scale-y-max: 140;

    lines {
      xs: csv('measurement.csv', time);
      ys: csv('measurement.csv', value2);
      colors: #06c;
    }

    axis {
      position: bottom;
      format: datetime("%H:%M:%S");
    }

    axis {
      position: left;
      layout: linear(20);
    }


More examples can be found on [the examples page](https://github.com/plotfx/plotfx/tree/master/examples).
For a more detailed introduction to PlotFX, see the [Getting Started](/documentation/getting-started) page. 
If you have any questions please don't hesitate to reach out via [the PlotFX email group](http://groups.google.com/group/plotfx).
+16 −15
Original line number Diff line number Diff line
# PlotFX v0.2.0

PlotFX is a tool for creating data-driven graphics; it allows you to create
parametric illustrations such as charts and dashboards using a lightweight
CSS-like syntax.
PlotFX is a command line tool and library for plotting data. The appearance of
plots can be customized using a lightweight syntax that is very similar to CSS.

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.
You can run PlotFX from the command line, where it generates SVG, PNG or PDF output
files. Additionally, you can embed it into your own application using the C API.

PlotFX is built in the hope that using it will be quick, simple and fun.

<div style="margin-top: 1.2em;">
  <a href="/documentation/getting_started" style="">Getting Started</a>
  <span style="margin: 0 .3em">·</span>
  <a href="/examples">Examples</a>
  <span style="margin: 0 .3em">·</span>
  <a href="/download">Download</a>
</div>

---

<p align="center">
  <img src="/examples/other/demo.svg" style="width: 90%; margin-top: 2em; margin-bottom: 2em;">
  <img src="/examples/other/demo.svg" style="margin-top: 1em; margin-bottom: 1em;">
  <span style="font-style: italic; color: #666;">A collection of example plots generated with PlotFX</span>
</p>

**WARNING**: The master branch recently underwent a significant refactoring and the
stability is currently beta/experimental. Maybe not even that. It will take a few
more weeks to stabilize and document everything.

<div class="notice">
  <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>