diff --git a/README.md b/README.md index 1a3901fcf9d2f46688349cf4cf8f342191c325dd..0247aa49c831c41b77ca9d343d3e7be2e30764b6 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,23 @@ -CrowdMP is a shared unity set of projects to create and run experiment with all -sort of crowds. -It is composed of: - + A Master project that contains the minimum and necessary code to run any - kind of experiement with crowd. - + A list of plugin projects that are link to the master one through git - submodules (plugins are added features that might not be needed to your - Experiement). -To use CrowdMP it is best to fork the Master project as well as any plugin -projects that you want to modify. - -[GIT SUBMODULES DOCUMENTATION] -https://www.vogella.com/tutorials/GitSubmodules/article.html - -[HOW TO FORK THE MASTER PROJECT] -1. Go on the gitlab page of the MASTER project - https://gitlab.inria.fr/crowdmp/crowdmp -2. Click on the fork button -3. When cloning your forked project it is adviced to not pull all the submodule - but to update only the one you require afterward - -[HOW TO USE CROWDMP AND CREATE AN EXPERIMENT] -See document "Doc_CrowdMP.docx" +CrowdMP is a shared unity set of projects to create and run experiment with all +sort of crowds. +It is composed of: + + A Master project that contains the minimum and necessary code to run any + kind of experiement with crowd. + + A list of plugin projects that are link to the master one through git + submodules (plugins are added features that might not be needed to your + Experiement). +To use CrowdMP it is best to fork the Master project as well as any plugin +projects that you want to modify. + +[GIT SUBMODULES DOCUMENTATION] +https://www.vogella.com/tutorials/GitSubmodules/article.html + +[HOW TO FORK THE MASTER PROJECT] +1. Go on the gitlab page of the MASTER project + https://gitlab.inria.fr/crowdmp/crowdmp +2. Click on the fork button +3. When cloning your forked project it is adviced to not pull all the submodule + but to update only the one you require afterward + +[HOW TO USE CROWDMP AND CREATE AN EXPERIMENT] +See document "Doc_CrowdMP.docx"