From 64bc95c3e9b511a0aed90a8d62e7f6d0454d1083 Mon Sep 17 00:00:00 2001 From: Tom Schoonjans Date: Sat, 20 Aug 2016 11:02:37 +0100 Subject: [PATCH] README update --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9d51e99..8f931ca 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,22 @@ easyRNG is licensed under the 3-clause BSD license. * Add random number generator and distributions to your C and Fortran code (or C++ if you really don't like the `random` template API :smile:) * API based on the [GNU scientific library's (GSL) random number generators](https://www.gnu.org/software/gsl/) and its [Fortran bindings FGSL](http://www.lrz.de/services/software/mathematik/gsl/fortran/) -* Has no dependencies, except a C++11 compliant compiler -* Tested on Linux, Mac OS X and Windows +* Has no dependencies, except a C++11 compliant compiler (and optionally a Fortran compiler) +* Thoroughly ested on Linux, Mac OS X and Windows * Distributed under the permissive 3-clause BSD license, while GSL and FGSL are licensed under the more restrictive GPLv3. -easyRNG is currently under heavy development: so far only (partial) support for C has been implemented (random number generators only, no distributions yet) +## Documentation + +Doxygen was used to generate [documentation](https://tschoonj.github.io/easyRNG), including usage instructions and examples. + +## Downloads + +See the [installation instructions](https://tschoonj.github.io/easyRNG/installation_instructions.html) on how to obtain a copy of easyRNG. Source tarballs are available, as well as binary packages for several Linux distributions. + +That's it! Don't hesitate to open an issue if something does not work as it's supposed to... + + + [![Build status](https://ci.appveyor.com/api/projects/status/q3aj9obkyswj2smv?svg=true)](https://ci.appveyor.com/project/tschoonj/easyrng) [![Build Status](https://travis-ci.org/tschoonj/easyRNG.svg?branch=master)](https://travis-ci.org/tschoonj/easyRNG)