Add acknowledgments and references in a sperate markdown file

README.md

@@ -1,6 +1,6 @@
 # PySocialForce
 
-This Project is based on [PySocialForce](https://github.com/yuxiang-gao/PySocialForce).
+This Project is based on [yuxiang-gao/PySocialForce](https://github.com/yuxiang-gao/PySocialForce).
 
 ## Installation
 
@@ -13,7 +13,7 @@ pip install -r requirements.txt
 pip install -e .
 ```
 
-`pip install -e .` will install the package in editable mode, so that you can modify the source code and import the package in python. It is additionally recommended to use a `virtualenv` to install the package.
+`pip install -e .` will install the package in editable mode, so that you can modify the source code and import the package in Python. It is additionally recommended to use a `virtualenv` to install the package.
 
 ## Examples
 
@@ -25,6 +25,7 @@ Examples can be found in the examples folder.
 pytest tests/*.py
 ```
 
-## History
+## Acknowledgments
 
-The old version of the README.md can be found in [README_old.md](README_old.md).
+- All acknowledgments can be found in [docs/acknowledgments.md](docs/acknowledgments.md).
+- The old version of the README.md can be found in [README_old.md](docs/README_old.md).

README_old.md → docs/README_old.md

@@ -1,27 +1,28 @@
 # PySocialForce
 
+> DEPRECATED: This README is deprecated and comes from [yuxiang-gao/PySocialForce](https://github.com/yuxiang-gao/PySocialForce).
+
 master: [![Build Status](https://travis-ci.com/yuxiang-gao/PySocialForce.svg?branch=master)](https://travis-ci.com/yuxiang-gao/PySocialForce)
 dev: [![Build Status](https://travis-ci.com/yuxiang-gao/PySocialForce.svg?branch=dev)](https://travis-ci.com/yuxiang-gao/PySocialForce)
 
 A Python Implementation of the Extended Social Force Model for Pedestrian Dynamics
 
 ## Table of Contents
 
-- [PySocialForce](#pysocialforce)
-  - [Table of Contents](#table-of-contents)
-  - [About The Project](#about-the-project)
-    - [Roadmap](#roadmap)
-  - [Installation](#installation)
-  - [Usage](#usage)
-  - [Configuration](#configuration)
-  - [Examples](#examples)
-    - [Ped-ped Scenarios](#ped-ped-scenarios)
-    - [Environmental obstacles](#environmental-obstacles)
-    - [Groups](#groups)
-  - [Contributing to this project](#contributing-to-this-project)
-  - [License](#license)
-  - [Acknowledgements](#acknowledgements)
-  - [References](#references)
+* [Table of Contents](#table-of-contents)
+* [About The Project](#about-the-project)
+  * [Roadmap](#roadmap)
+* [Installation](#installation)
+* [Usage](#usage)
+* [Configuration](#configuration)
+* [Examples](#examples)
+  * [Ped-ped Scenarios](#ped-ped-scenarios)
+  * [Environmental obstacles](#environmental-obstacles)
+  * [Groups](#groups)
+* [Contributing to this project](#contributing-to-this-project)
+* [License](#license)
+* [Acknowledgements](#acknowledgements)
+* [References](#references)
 
 ## About The Project
 

docs/acknowledgments.md

@@ -0,0 +1,15 @@
+## Acknowledgments
+
+- This project is based on [yuxiang-gao/PySocialForce](https://github.com/yuxiang-gao/PySocialForce)'s implementation of the extended social force model.
+- yuxiang-gao/PySocialForce is based on [svenkreiss](https://github.com/svenkreiss)'s implementation of the vanilla social force model.
+- The implementation of forces drew inspiration from the [pedsim_ros][pedsim_ros] package.
+
+## References
+
+<a id="1">[1]</a> Helbing, D., & Molnár, P. (1995). Social force model for pedestrian dynamics. Physical Review E, 51(5), 4282–4286. <https://doi.org/10.1103/PhysRevE.51.4282>
+
+<a id="2">[2]</a> Moussaïd, M., Perozo, N., Garnier, S., Helbing, D., & Theraulaz, G. (2010). The walking behaviour of pedestrian social groups and its impact on crowd dynamics. PLoS ONE, 5(4), 1–7. <https://doi.org/10.1371/journal.pone.0010047>
+
+[socialforce]: https://github.com/svenkreiss/socialforce
+
+[pedsim_ros]: https://github.com/srl-freiburg/pedsim_ros