README.md

   1 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
   2 [![Build Status](https://ci.inria.fr/simgrid/buildStatus/icon?job=SimGrid)](https://ci.inria.fr/simgrid/job/SimGrid/)
   3 [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/gvcssh340fwtoc35?svg=true)](https://ci.appveyor.com/project/mquinson/simgrid)
   4 [![SonarCloud Status](https://sonarcloud.io/api/project_badges/measure?project=simgrid_simgrid&metric=alert_status)](https://sonarcloud.io/dashboard/?id=simgrid_simgrid)
   5 [![Doc](https://readthedocs.org/projects/pip/badge/?version=stable)](https://simgrid.org/doc/latest/)
   6 [![License: LGPL v2.1][license-badge]](COPYING)
   7 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1845/badge)](https://bestpractices.coreinfrastructure.org/projects/1845)
   8
   9 # Welcome to the SimGrid project!
  10
  11 SimGrid is a scientific instrument to study the behavior of
  12 large-scale distributed systems such as Grids, Clouds, HPC or P2P
  13 systems. It can be used to evaluate heuristics, prototype applications
  14 or even assess legacy MPI applications.
  15
  16 ## Installation
  17 Documentation: [online](https://simgrid.org/doc/latest/Installing_SimGrid.html#installing-from-the-source);
  18 [local copy](docs/source/Installing_SimGrid.rst). TL;DR:
  19 ```
  20 cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid .
  21 # Check the full list of options with `cmake -LH`
  22 make
  23 make install
  24 ```
  25
  26 ## More information
  27 [Online documentation](https://simgrid.org/doc/latest/) or
  28 [local version](docs/source).
  29
  30 You can also ask your questions, or simply discuss with other users on
  31 to the [SimGrid mattermost](https://framateam.org/simgrid/channels/town-square)
  32 or on the #simgrid IRC channel of the oftc network.
  33
  34 Last, note that although we maintain a [GitHub mirror](https://github.com/simgrid/simgrid/) and an [Inria GitLab mirror](https://gitlab.inria.fr/simgrid/simgrid), the main development of SimGrid is done on [Framagit](https://framagit.org/simgrid/simgrid/).
  35
  36 Thanks for using our software. Please do great things with it and tell
  37 the world about it. Tell us, too, because we love to have positive
  38 feedback. Welcome to our community.
  39
  40 Cheers,
  41 Da SimGrid Team.
  42
  43 [license-badge]: https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg
  44 [release-badge]: https://img.shields.io/github/release/simgrid/simgrid.svg
  45 [release-link]:  https://gforge.inria.fr/frs/?group_id=12