Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Initialize pointers with a known invalid (out-of-bound) value.
[simgrid.git] / README.md
index e5e0f1b9498853d973e994b90a914c3ab9251735..b3157c301f366ebd779f8e6f9c30a90f39d7c819 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,10 +1,9 @@
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
-[![Travis Status](https://travis-ci.org/simgrid/simgrid.svg?branch=master)](https://travis-ci.org/simgrid/simgrid)
+[![Build Status](https://ci.inria.fr/simgrid/buildStatus/icon?job=SimGrid)](https://ci.inria.fr/simgrid/job/SimGrid/)
 [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/gvcssh340fwtoc35?svg=true)](https://ci.appveyor.com/project/mquinson/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&amp)
-[![Doc](https://readthedocs.org/projects/pip/badge/?version=stable)](http://simgrid.gforge.inria.fr/simgrid/latest/doc/)
-[![License: LGPL v3][license-badge]](COPYING)
+[![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!
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1845/badge)](https://bestpractices.coreinfrastructure.org/projects/1845)
 
 # Welcome to the SimGrid project!
@@ -14,21 +13,33 @@ large-scale distributed systems such as Grids, Clouds, HPC or P2P
 systems. It can be used to evaluate heuristics, prototype applications 
 or even assess legacy MPI 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).
+
+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, 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/).
 
 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
 
 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.
+feedback. Welcome to our community.
 
 Cheers,
 Da SimGrid Team.
 
 
 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
 [release-badge]: https://img.shields.io/github/release/simgrid/simgrid.svg
 [release-link]:  https://gforge.inria.fr/frs/?group_id=12