Merge pull request #6 from AaronPB/develop

Release of version 1.0

README.md

@@ -1,14 +1,23 @@
 # Force Platform Data Reader
 
 ## Information
+
 A python script for sensor data management of a force platform.
 
 It supports currently the following sensor types:
-- Phidget-Bridge compatible load sensors. (Requires Phidget dependency)
-- Taobotics IMU sensors. (Requires MRPT dependency)
+- Phidget-Bridge compatible load sensors. (Requires Phidget dependency).
+- Taobotics IMU sensors. (Requires MRPT dependency).
+
+## Documentation
+
+Program documentation is available to learn how the program works and how to use it.
+
+Check it out [here](docs/home.md).
+
+## Quick setup
 
-## Setup
 To use this project, clone it and install the project requirements.
+
 > Do it in a virtual environment to avoid module installation issues (using `virtualenv`, for example).
 > 
 > This project is developed with Python v3.10.6
@@ -19,6 +28,7 @@ pip install -r requirements.txt
 ```
 
 ### Phidget dependency
+
 For [Linux](https://www.phidgets.com/docs/OS_-_Linux#Quick_Downloads):
 
 ```bash
@@ -29,6 +39,7 @@ sudo apt-get install -y libphidget22
 > For [Windows](https://www.phidgets.com/docs/OS_-_Windows#Quick_Downloads) or [MacOS](https://www.phidgets.com/docs/OS_-_macOS#Quick_Downloads)
 
 ### MRPT dependency
+
 For more information, refer to the [MRPT Documentation](https://docs.mrpt.org/reference/latest/download-mrpt.html#debian-ubuntu-ppa)
 
 ```bash
@@ -37,4 +48,4 @@ sudo apt install libmrpt-dev mrpt-apps
 sudo apt install python3-pymrpt
 ```
 
-> If you are using `virtualenv`, MRPT cannot be installed by pip. As a temporary solution, set `include-system-site-packages = true` in your `pyvenv.cfg` file.
+> If you are using `virtualenv`, MRPT cannot be installed by pip. As a temporary solution, set `include-system-site-packages = true` in your `pyvenv.cfg` file.