Merge branch 'master' of https://[email protected]/brandmaier/onyx

README.md

@@ -1,9 +1,24 @@
+![Onyx Logo](https://github.com/brandmaier/onyx/blob/master/build/images/onyx-welcome.png?raw=true)
+
+![](https://img.shields.io/github/commit-activity/m/brandmaier/onyx)
+![](https://tokei.rs/b1/github/brandmaier/onyx)
+![](https://img.shields.io/github/issues/brandmaier/onyx)
+![Code size](https://img.shields.io/github/languages/code-size/brandmaier/onyx.svg)
+![contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)
+<!-- badges: end -->
+
 # Onyx
 
-Onyx is a free software environment for creating and estimating structural equation models (SEM). It provides a graphical user interface that facilitates an intuitive creation of models, and a powerful back end for performing maximum likelihood estimation of parameters. Path diagrams in Onyx can be exported to OpenMx, lavaan, and Mplus to allow an easy transition to script-based SEM software. Onyx was written by Timo von Oertzen and Andreas M. Brandmaier.
+Onyx is a free software environment for creating and estimating structural equation models (SEM). It provides a graphical user interface that facilitates an intuitive creation of models, and a powerful back end for performing maximum likelihood estimation of parameters. Path diagrams in Onyx can be exported to OpenMx, lavaan, and Mplus to allow an easy transition to script-based SEM software. Onyx was written by Timo von Oertzen and [Andreas M. Brandmaier](https://www.brandmaier.de) and is freely distributed under the Apache 2.0 license.
+
+# Download
+
+You can download the current (unstable) version of Onyx from this repository. The most recent version is automatically regularly built and deployed [here](https://github.com/brandmaier/onyx/tree/master/dist). 
+Download the JAR-file and run it. Note that Onyx requires a recent JAVA runtime environment, such as OpenJDK.
 
 # Build
 
+This section is only for developers. As an Onyx user, you can safely ignore this information. 
 If you want to build Onyx from sources, download the sources, make sure that you have a Java development kit ready (including a Java compiler) and the Apache ant build tool. Then, compile the source code using
 
 ```{bash}
@@ -30,6 +45,8 @@ java -jar onyx.jar
 
 # License
 
+Onyx is made available under the Apache 2.0 license.
+
 Onyx uses various (unmodified) libraries, which are here redistributed under their original licenses:
 
 - vectorgraphics2d by Erich Seifert is distributed under the LGPL