Fix the documentation after changing the repository name (#4)

CMakeLists.txt

@@ -6,13 +6,13 @@
 ################################################################################
 
 cmake_minimum_required(VERSION 3.5)
-project(ironcub_software
+project(ironcub_mk1_software
         VERSION 0.0.1
         LANGUAGES C CXX)
 
 # Disable in source build
 if("${PROJECT_SOURCE_DIR}" STREQUAL "${PROJECT_BINARY_DIR}")
-   message(FATAL_ERROR "In-source builds of ironcub_software are not allowed. "
+   message(FATAL_ERROR "In-source builds of ironcub_mk1_software are not allowed. "
                        "Please remove CMakeCache.txt and the CMakeFiles/ directory, then build out-of-source. "
                        "If you really want to do an in-source build, feel free to comment out this error.")
 endif("${PROJECT_SOURCE_DIR}" STREQUAL "${PROJECT_BINARY_DIR}")
@@ -71,4 +71,3 @@ add_subdirectory(models)
 # Configure MATLAB startup file
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/templates/setup_v1.in ${CMAKE_BINARY_DIR}/share/setup_v1${SETUP_SCRIPT_EXTENSION})
 INSTALL(FILES ${CMAKE_BINARY_DIR}/share/setup_v1${SETUP_SCRIPT_EXTENSION} DESTINATION ${CMAKE_INSTALL_PREFIX}/share/ironcub)
-

README.md

@@ -42,7 +42,7 @@ The installation procedure has been tested on Ubuntu 20.04 and Windows 10.
 On **Linux** or **macOS**, run:
 
 ```bash
-cd ironcub_software
+cd ironcub_mk1_software
 mkdir build
 cd build
 cmake .. -DCMAKE_INSTALL_PREFIX="/path/to/desired/install/dir" .
@@ -52,7 +52,7 @@ make install
 On **Windows**, run:
 
 ```cmd
-cd ironcub_software
+cd ironcub_mk1_software
 mkdir build
 cd build
 cmake .. -G"Visual Studio 16 2019" -DCMAKE_INSTALL_PREFIX="\path\to\desired\install\dir"
@@ -74,7 +74,7 @@ rem Unset the MESA variable (maybe useless on Windows)
 set MESA_LOADER_DRIVER_OVERRIDE=
 ```
 
-In this way the `batch` file will load both the setup script from the `robotology-superbuild` and the `ironcub_software`. Then, download **Windows Terminal** from the _Microsoft Store_.
+In this way the `batch` file will load both the setup script from the `robotology-superbuild` and the `ironcub_mk1_software`. Then, download **Windows Terminal** from the _Microsoft Store_.
 
 Launch the Windows Terminal app, go on `settings` and `Create a new profile`, then create a new profile specifying the new name and the tab-name.
 
@@ -104,13 +104,13 @@ This `sh` file contains the paths that are needed to use this repo.
 
 To better understand which variables are set by the `setup-v1.sh` script, see also these READMEs:
 
-- https://github.com/ami-iit/ironcub_software/tree/porting_mk1_mk1_1/models/worlds#usage
-- https://github.com/ami-iit/ironcub_software/blob/porting_mk1_mk1_1/lib/gazebo/README.md#setting-up-env-variables
-- https://github.com/ami-iit/ironcub_software/tree/porting_mk1_mk1_1/models#installation-and-usage
+- https://github.com/ami-iit/ironcub_mk1_software/tree/porting_mk1_mk1_1/models/worlds#usage
+- https://github.com/ami-iit/ironcub_mk1_software/blob/porting_mk1_mk1_1/lib/gazebo/README.md#setting-up-env-variables
+- https://github.com/ami-iit/ironcub_mk1_software/tree/porting_mk1_mk1_1/models#installation-and-usage
 
 ## Content
 
-Documentation entry points for the different folders are in the [wiki](https://github.com/ami-iit/ironcub_software/wiki) of the repo.
+Documentation entry points for the different folders are in the [wiki](https://github.com/ami-iit/ironcub_mk1_software/wiki) of the repo.
 
 - [flight-controllers-stable](flight-controllers-stable): Simulink controllers to run simulations of `iRonCub-Mk1` and `iRonCub-Mk1_1` flying in Gazebo simulator.
 

lib/gazebo/README.md

@@ -31,7 +31,7 @@ The plugin can be used in three different ways, depending on the cmake options w
 
 |      cmake option       |     Description                                  |
 | :---------------------: | :------------------------------------------------------: | 
-| `USE_NONLINEAR_JET_DYNAMICS_PLUGIN` | when TRUE, the jets dynamics is simulated with a model obtained from experiment data, and assuming throttle as input. ([reference](https://github.com/ami-iit/ironcub_software/blob/porting_mk1_mk1_1/lib/gazebo/README.md#references)) |
+| `USE_NONLINEAR_JET_DYNAMICS_PLUGIN` | when TRUE, the jets dynamics is simulated with a model obtained from experiment data, and assuming throttle as input. ([reference](https://github.com/ami-iit/ironcub_mk1_software/blob/porting_mk1_mk1_1/lib/gazebo/README.md#references)) |
 | `USE_FIRST_ORDER_JET_DYNAMICS_PLUGIN` | when TRUE, the jets dynamics is simulated with a simple integrator. The input is thrust derivative. |
 |    | if both previuos options are FALSE, The input is assumed to be the thrust which is instantly set to Gazebo with no dynamics. |
 
@@ -54,7 +54,7 @@ The parameters supported by the plugin's `.ini` YARP configuration file are:
 | inverse-time-constant-in-one-over-seconds |      -       |     double      | 1/seconds |       -       |   Yes    |                                                                    Inverse of the time constant of the first order dynamics of the jets (related to `USE_FIRST_ORDER_JET_DYNAMICS_PLUGIN` option).                                                                    |       |
 |                 link-jets                 |              | list of strings |     -     |       -       |   Yes    | List of SDF link names on which the jets are supposed to be attached. The force of the jet is supposed to be applied to the origin of the link frame, along the direction specified by the jet-axis option. |
 |                 jet-axis                  |              | list of vectors |     -     |       -       |   Yes    |   List of the axis along with the thrust force is applied, expressed w.r.t. the link frame. For the moment, the force of the jet is supposed to be applied only along one of the axis of the link frame.    |
-|               jet-coefficients                  |              | list of vectors |     -     |       -       |   Yes    |   List of the coefficients representing the dynamic model of the jet engines. For more details see also ([reference](https://github.com/ami-iit/ironcub_software/blob/porting_mk1_mk1_1/lib/gazebo/README.md#references)).    |
+|               jet-coefficients                  |              | list of vectors |     -     |       -       |   Yes    |   List of the coefficients representing the dynamic model of the jet engines. For more details see also ([reference](https://github.com/ami-iit/ironcub_mk1_software/blob/porting_mk1_mk1_1/lib/gazebo/README.md#references)).    |
 
 Example configuration file:
 
@@ -99,4 +99,3 @@ The ports opened by the plugin are the following:
   doi={10.1109/LRA.2020.2970572}}
 
 ```
-