Added a draft of README

.github/workflows/conda-forge-ci.yml

@@ -32,7 +32,7 @@ jobs:
         # Compilation related dependencies
         mamba install cmake compilers make ninja pkg-config
         # Actual dependencies
-        mamba install glew glfw eigen yarp imgui
+        mamba install glew glfw yarp imgui
 
     - name: OpenGL [Linux]
       if: contains(matrix.os, 'ubuntu')

README.md

@@ -1,2 +1,32 @@
 # yarp-device-keyboard-joypad
-Repository containing the implementation of a yarp device to use a keyboard as a joypad
+Repository containing the implementation of a yarp device to use a keyboard as a joypad.
+
+## Dependencies
+- [``YARP``](https://github.com/robotology/yarp) (>= 3.4.0) 
+- [``YCM``](https://github.com/robotology/ycm)
+- ``glfw3``
+- ``GLEW``
+- [``imgui``](https://github.com/ocornut/imgui) (Will be downloaded automatically if not found)
+
+The dependencies can also be installed via [``mamba``](https://github.com/mamba-org/mamba) using the following command:
+```bash
+mamba install cmake compilers make ninja pkg-config glew glfw yarp imgui
+```
+
+## Configuration parameters
+The device can be configured using the following parameters. They are all optional and have default values.
+- ``button_size``: size of the buttons in pixels (default: 100)
+- ``min_button_size``: minimum size of the buttons in pixels in the corresponding slider (default: 50)
+- ``max_button_size``: maximum size of the buttons in pixels in the corresponding slider (default: 200)
+- ``font_multiplier``: multiplier for the font size (default: 1)
+- ``min_font_multiplier``: minimum value for the font multiplier in the corresponding slider (default: 0.5)
+- ``max_font_multiplier``: maximum value for the font multiplier in the corresponding slider (default: 4.0)
+- ``gui_period``: period in seconds for the GUI (default: 0.033)
+- ``window_width``: width of the window in pixels (default: 1280)
+- ``window_height``: height of the window in pixels (default: 720)
+- ``buttons_per_row``: number of buttons per row in the "Buttons" widget (default: 4)
+- ``allow_window_closing``: when specified or set to true, the window can be closed by pressing the "X" button in the title bar. Note: when using this as device, the parent might keep running anyway (default: false)
+- ``axes``: definition of the list of axes. The allowed values are "ws", "ad", "up_down" and "left_right". It is possible to select the default sign for an axis prepending a "+" or a "-" to the axis name. For example, "+ws" will set the "ws" axis with the default sign, while "-ws" will set the "ws" axis with the inverted sign. It is also possible to repeat some axis, and use "none" or "" to have dummy axes with always zero value. The order matters. (default: ["ad", "ws", "left_right", "up_down"])
+- ``wasd_label``: label for the "WASD" widget (default: "WASD")
+- ``arrows_label``: label for the "Arrows" widget (default: "Arrows")
+- ``buttons``: definition of the list of buttons. The allowed values are all the letters from A to Z, all the numbers from 0 to 9, "SPACE", "ENTER", "ESCAPE", "BACKSPACE", "DELETE", "LEFT", "RIGHT", "UP", "DOWN". It is possible to repeat some button. It is possible to specify an alias after a ":". For example "A:Some Text" will create a button with the label "Some Text" that can be activated by pressing "A". It is possible to use "none" or "" to indicate a dummy button always zero. It is possible to repeat buttons. The order matters. (default: ())