Browse Source

Added basic information on installation; linked to the main
documentation as well

Yentl Van Tendeloo 8 years ago
parent
commit
f108b1e4be
1 changed files with 18 additions and 0 deletions
  1. 18 0
      README.md

+ 18 - 0
README.md

@@ -0,0 +1,18 @@
+Installation
+============
+
+You can easily install PythonPDEVS with the following command.
+```sh
+cd src
+python setup.py install --user
+```
+
+Distributed simulation (optional)
+---------------------------------
+
+To use distributed simulation capabilities, run the script *install_mpi4py.sh* to install the necessary MPI library and bindings.
+
+Documentation
+=============
+
+Detailed documentation of the installation and use of PythonPDEVS can be found in the [PythonPDEVS documentation](https://msdl.uantwerpen.be/documentation/PythonPDEVS).