Skip to content
Snippets Groups Projects
Commit 20148d3b authored by Tim Molter's avatar Tim Molter
Browse files

revamp of read me

parent aa9fc874
No related branches found
No related tags found
No related merge requests found
Description
===============
XChart is a light-weight and convenient library for plotting data.
XChart is a charting API for Java. While several charting APIs already
exist, most of them require a steep learning curve and the code base
is bloated, full of too many "features" and/or very outdated.
Inspired by SWTCharts, simplicity is prioritized over everything else
so you can quickly make a plot and move on. XCharts can be used in
your Swing, Java EE, and Java SE applications. If you're looking for
a Java charting API that is easy to use and does not need every feature
under the sun, XChart is for you.
Its focus is on simplicity and ease-of-use, requiring only two lines of code to save or display a basic default chart.
Bugs
Usage is very simple: Create a Chart instance, add a series of data to it, and either save it or display it.
Example
===============
Please report any bugs or submit feature requests to [XChart's Github issue tracker](https://github.com/timmolter/XChart/issues).
double[] xData = new double[] { 0.0, 1.0, 2.0 };
double[] yData = new double[] { 2.0, 1.0, 0.0 };
Getting Started
// Create Chart
Chart chart = QuickChart.getChart("Sample Chart", "X", "Y", "y(x)", xData, yData);
// Show it
new SwingWrapper(chart).displayChart();
// Save it
BitmapEncoder.savePNG(chart, "./Sample_Chart.png");
Now go ahead and [study some more examples](http://xeiam.com/xchart_examplecode.jsp), [download the thing](http://xeiam.com/xchart_changelog.jsp) and [provide feedback](https://github.com/timmolter/XChart/issues).
Features
===============
* no additional dependencies
* ~50KB Jar
* line charts
* scatter charts
* error bars
* Date x-axis
* multiple series
* extensive customization
Getting Started
===============
Non-Maven
---------
Download Jar: http://xeiam.com/xchart.jsp
......@@ -31,22 +49,32 @@ Add the XChart library as a dependency to your pom.xml file:
<dependency>
<groupId>com.xeiam</groupId>
<artifactId>xchart</artifactId>
<version>1.2.2.SNAPSHOT</version>
<version>1.2.1</version>
</dependency>
For snapshots, add the following repository to your pom.xml file:
For snapshots, add the following to your pom.xml file:
<repository>
<id>xchart-snapshot</id>
<snapshots/>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</repository>
<dependency>
<groupId>com.xeiam</groupId>
<artifactId>xchart</artifactId>
<version>1.2.2-SNAPSHOT</version>
</dependency>
Building
===============
mvn clean package
mvn javadoc:javadoc
Bugs
===============
Please report any bugs or submit feature requests to [XChart's Github issue tracker](https://github.com/timmolter/XChart/issues).
Donations
===============
17dQktcAmU4urXz7tGk2sbuiCqykm3WLs6
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment