Commit 336a9068 authored by Paul Asmuth's avatar Paul Asmuth
Browse files

update readme, introduction, faq, github url

parent c65a039d
Loading
Loading
Loading
Loading
+3 −3
Original line number Diff line number Diff line
fviz
====

fviz is a text-based drawing program. It generates custom charts, figures and other
visualizations from simple expressions.
fviz is a text-based data visualization program. It generates custom charts,
dashboards and other illustrations from simple expressions.

You can run fviz from the command line, where it generates SVG, PNG and PDF
output files. Additionally, you can embed it into your own application using the
@@ -47,7 +47,7 @@ If everything works, you should get an output file similar to the one below

More examples can be found on [the examples page](https://fviz.org/examples).
For a more detailed introduction to fviz, see the [Getting Started](https://fviz.org/documentation/getting-started) page.
If you have any questions please don't hesitate to reach out via [GitHub issues](https://github.com/fviz/fviz).
If you have any questions please don't hesitate to reach out via [GitHub issues](https://github.com/asmuth/fviz).


Building
+2 −2
Original line number Diff line number Diff line
@@ -41,7 +41,7 @@ tpl = """

    <article class="{{article_class}}">
      <div class="header">
        <a style="display: block; text-decoration: none; color: #666; float: right; margin-top: 2em;" href="http://github.com/fviz/fviz" target="_blank">
        <a style="display: block; text-decoration: none; color: #666; float: right; margin-top: 2em;" href="http://github.com/asmuth/fviz" target="_blank">
          View on <img src="https://github.githubassets.com/images/modules/logos_page/GitHub-Logo.png" style="height: 12px; position: relative; top: 1px; margin-left: 2px;">
        </a>

@@ -56,7 +56,7 @@ tpl = """
      </div>

      <div style="text-align: right; margin-top: 10em; font-size: 80%;">
        <a class="link" target="_blank" href="https://github.com/fviz/fviz/blob/master/manual">
        <a class="link" target="_blank" href="https://github.com/asmuth/fviz/blob/master/manual">
          Edit this page on GitHub
        </a>
      </div>
+1 −1
Original line number Diff line number Diff line
@@ -15,6 +15,6 @@ Here are some ways to contribute to fviz:

## Individual Contributors to fviz

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

+1 −1
Original line number Diff line number Diff line
@@ -5,5 +5,5 @@ There are a number of ways to obtain the fviz sources:

### Source Code (Github)

You can find the complete [source code on Github](http://github.com/fviz/fviz)
You can find the complete [source code on Github](http://github.com/asmuth/fviz)
+0 −42
Original line number Diff line number Diff line
@@ -17,45 +17,3 @@ installed on your machine. To verify that this is the case, run `fc-match
'Arial,Helvetica,Helvetica Neue:style=Regular,Roman'` and check that it returns
the correct 'arial.ttf' file.

### What are some differences between fviz and other chart generators?

While fviz's primary usecase *is* creating charts, it is at the core not a
chart generator, but a parametric drawing application that happens to be very
well suited to drawing charts.

When building charts, this approach does not always result in the shortest possible
configuration files, but it gives you a lof of flexibility for customizing your
illustrations in ways that were unforseen by the fviz authors.

Other things that differentiate fviz from other chart generators are its license,
the fact that it is written in C++ and can be embedded into any application and
its CSS-like configuration language.


### How does fviz compare to HTML/CSS?

Most readers will know CSS so it might be useful to point out the similarities
and differences between fviz and HTML/CSS, since both lay out elements as a
nested tree of boxes and have very similar syntax.

However, that is pretty much where the similarities end. A CSS file contains a
list of rules that are later applied to a tree of elements defined elsewhere. A
fviz files contains a list of definitions. Each definition corresponds 1:1
to an element which is implicitly created.

Also, since CSS is (also) intended for creating text documents, it is based around a 
concept of universal "page flow", i.e. by default block elements in CSS will be
stacked vertically from top to bottom, similar to the way rows of text are placed
one after another other in a page.

This concept of page flow, or page layout does not exit in fviz.
fviz is a tool for creating illustrations, not a document publishing system, so
it does make sense to assume "top to bottom" as a default element placement strategy.

So instead of being stacked horizontally within the parent box, like in CSS, boxes
in fviz will, by default, simply be drawn on top of each other with each one
filling up the entirety of the parent box. This is a much more useful default
behaviour for creating illustrations where in many cases an element more closely
resembles the concept of a 'layer' as found in graphics editing software such as
Photoshop or Illustrator than that of a row of text.
Loading