Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
ffevotte committed May 19, 2017
1 parent 8be406c commit ebabfcf
Showing 1 changed file with 44 additions and 3 deletions.
47 changes: 44 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,20 @@ modes. This can be seen as an asynchronous variant of the CESTAC method, or a
subset of Monte Carlo Arithmetic, performing only output randomization through
random rounding.

**NB:** This is the *stable* version of Verrou. It is based on Valgrind-3.10.1,
which supports only relatively old configurations:
**NB:** This is released version 0.9 of Verrou. It is based on Valgrind-3.10.1,
which supports the following system configurations:

- `gcc`, versions 3.x to 5.x
- `clang`, versions 2.9 to 4.x
- `glibc`, versions 2.2 to 2.20

In order to install Verrou on newer platforms, please use the [`valgrind-update`](https://github.com/edf-hpc/verrou/tree/valgrind-update) branch.

## Installation

The installation procedure described here has been tested only on Linux
platforms. It may also work for MacOS, but this has never been tested.


### Get the sources

Fetch valgrind's sources:
Expand Down Expand Up @@ -83,3 +86,41 @@ Beware, this requires lots of tools which are not necessarily tested for in
- xsltproc
- docbook-xsl


## Contributing

Please let us know if you used Verrou (successfully or not), and even more if it
helped you improve the quality of your code.

Also, if you make improvements to this code or have suggestions, please do not
hesitate to fork the repository or submit bug reports on
[github](https://github.com/edf-hpc/verrou). The repository's URL is:

https://github.com/edf-hpc/verrou.git


### Contributors

- [F. Févotte](https://github.com/ffevotte)
- [B. Lathuilière](https://github.com/lathuili)



## License

Copyright (C) 2014-2017, EDF.

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place, Suite 330, Boston, MA 02111-1307, USA.

The GNU General Public License is contained in the file COPYING.

0 comments on commit ebabfcf

Please sign in to comment.