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