X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/717bb82fd56727b8a066418eaa654290373736ea..refs/heads/master:/README.md diff --git a/README.md b/README.md index 8d68274791..1c0a668c1d 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,43 @@ -[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) -[![Travis Status](https://img.shields.io/travis/simgrid/simgrid/master.svg?logo=travis)](https://travis-ci.org/simgrid/simgrid) -[![AppVeyor Status](https://ci.appveyor.com/api/projects/status/gvcssh340fwtoc35?svg=true)](https://ci.appveyor.com/project/mquinson/simgrid) -[![SonarCloud Status](https://sonarcloud.io/api/project_badges/measure?project=simgrid&metric=alert_status)](https://sonarcloud.io/dashboard/?id=simgrid) -[![Codacy Badge](https://api.codacy.com/project/badge/Grade/bf1bdba50440485fbda2ac19f462ccc7)](https://www.codacy.com/app/mquinson/simgrid?utm_source=github.com&) -[![Doc](https://readthedocs.org/projects/pip/badge/?version=stable)](http://simgrid.gforge.inria.fr/simgrid/latest/doc/) -[![License: LGPL v3][license-badge]](COPYING) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) +[![Build Status](https://ci.inria.fr/simgrid/buildStatus/icon?job=SimGrid)](https://ci.inria.fr/simgrid/job/SimGrid/) +[![SonarCloud Status](https://sonarcloud.io/api/project_badges/measure?project=simgrid_simgrid&metric=alert_status)](https://sonarcloud.io/dashboard/?id=simgrid_simgrid) +[![Doc](https://readthedocs.org/projects/pip/badge/?version=stable)](https://simgrid.org/doc/latest/) +[![License: LGPL v2.1][license-badge]](COPYING) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1845/badge)](https://bestpractices.coreinfrastructure.org/projects/1845) # Welcome to the SimGrid project! -SimGrid is a scientific instrument to study the behavior of +SimGrid is a scientific instrument to study the behavior of large-scale distributed systems such as Grids, Clouds, HPC or P2P -systems. It can be used to evaluate heuristics, prototype applications +systems. It can be used to evaluate heuristics, prototype applications or even assess legacy MPI applications. -More documentation is included in this archive (doc/html/index.html) -or [online](http://simgrid.gforge.inria.fr/) +## Installation +Documentation: [online](https://simgrid.org/doc/latest/Installing_SimGrid.html#installing-from-the-source); +[local copy](docs/source/Installing_SimGrid.rst). TL;DR: +``` +cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid . +# Check the full list of options with `cmake -LH` +make +make install +``` -In any case, you may want to subscribe to the [user mailing list](http://lists.gforge.inria.fr/mailman/listinfo/simgrid-user). -There, you can find answers to your questions, or simply discuss with -people doing the same kind of research than you do, in an active and -friendly community. +## More information +[Online documentation](https://simgrid.org/doc/latest/) or +[local version](docs/source). -Thanks for using our software. Please do great things with it and tell -the world about it. Tell us, too, because we love to have positive -feedback. +You can also ask your questions, or simply discuss with other users on +to the [SimGrid mattermost](https://framateam.org/simgrid/channels/town-square) +or on the #simgrid IRC channel of the oftc network. + +Last, the main development of SimGrid is done on [Framagit](https://framagit.org/simgrid/simgrid/), +but we also maintain a [GitHub mirror](https://github.com/simgrid/simgrid/) and an [Inria GitLab mirror](https://gitlab.inria.fr/simgrid/simgrid), + +Thanks for using our software. Please do great things with it and tell the world about it. +Tell us, too, because we love to have positive feedback. Welcome to our community. Cheers, Da SimGrid Team. -[license-badge]: https://img.shields.io/badge/License-LGPL%20v3-blue.svg +[license-badge]: https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg [release-badge]: https://img.shields.io/github/release/simgrid/simgrid.svg -[release-link]: https://gforge.inria.fr/frs/?group_id=12