From 604d841c8a82e8226ecae849621262622a6cebb1 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Tue, 9 Jul 2019 18:27:22 +0200 Subject: [PATCH] doc: improve install page --- docs/source/Installing_SimGrid.rst | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/source/Installing_SimGrid.rst b/docs/source/Installing_SimGrid.rst index bb655faf1b..a61c5df050 100644 --- a/docs/source/Installing_SimGrid.rst +++ b/docs/source/Installing_SimGrid.rst @@ -16,15 +16,14 @@ Pre-compiled Packages Binaries for Linux ^^^^^^^^^^^^^^^^^^ -To get all of SimGrid on Debian or Ubuntu, simply type the following. +To get all of SimGrid on Debian or Ubuntu, simply type one of the +following lines, or several lines if you need several languages. .. code-block:: shell - apt install libsimgrid-dev simgrid-java - -The package ``libsimgrid-dev`` is sufficient if you only plan to use the -C or C++ interfaces of SimGrid while ``simgrid-java`` if you only plan -to use the Java bindings. + apt install libsimgrid-dev # if you want to develop in C or C++ + apt install simgrid-java # if you want to develop in Java + apt install python3-simgrid # if you want to develop in Python If you build pre-compiled packages for other distributions, drop us an email. @@ -35,7 +34,7 @@ Stable Java Package ^^^^^^^^^^^^^^^^^^^ The jar file can be retrieved from the `Release page -`_. This file is +`_. This file is self-contained, including the native components for Linux, macOS and Windows. Copy it to your project's classpath and you're set. @@ -78,7 +77,7 @@ C++ compiler (either g++, clang, or icc). boost). SimGrid compiles well with `clang` or `icc` too. Python 3. SimGrid should build without Python, that is only needed by our regresion test suite. -cmake (v2.8.8). +cmake (v3.5). ``ccmake`` provides a nicer graphical interface compared to ``cmake``. Press ``t`` in ``ccmake`` if you need to see absolutely all configuration options (e.g., if your python installation is not standard). @@ -106,7 +105,7 @@ Getting the Sources ^^^^^^^^^^^^^^^^^^^ Grab the last **stable release** from `FramaGit -`_, and compile it as follows: +`_, and compile it as follows: .. code-block:: shell -- 2.20.1