|license_badge| |codecov_badge| |doc_badge|
Welcome to robot_folders! robot_folders is a collection of utility scripts designed to
streamline and facilitate the management of workspaces used for (ROS) development. It is designed
to enhance efficiency in handling different environments, consisting of multiple workspaces like a
catkin_workspace and colcon_workspace or a plain CMake workspace.
It focuses on optimizing the management of various subworkspaces, contributing to a seamless development experience.
Documentation can be found on our GH pages <https://fzi-forschungszentrum-informatik.github.io/robot_folders/>_.
It is recommended to install robot_folders using pipx (You can install pipx using sudo apt install pipx).
.. code:: bash
pipx install robot-folders
Upgrade ^^^^^^^
To upgrade robot_folders using pipx do
.. code:: bash
pipx upgrade robot-folders
Shell setup ^^^^^^^^^^^
In order to use robot_folders you'll have to call its source file. How to do this depends on
the way you installed robot_folders and on the version of the installation tool.
In case you have installed
robot_folders using pipx as described above (and given you use the bash shell), do:
.. code:: bash
echo "source ${HOME}/.local/pipx/venvs/robot-folders/bin/rob_folders_source.sh" >> ~/.bashrc
echo "source ${HOME}/.local/share/pipx/venvs/robot-folders/bin/rob_folders_source.sh" >> ~/.bashrc
In case you manually installed robot_folders using a python virtualenv the path is similarly
.. code:: bash
echo "source
Basic usage ^^^^^^^^^^^
After installation open up a new terminal to use robot_folders. The main
command for using robot_folders is fzirob. Type
.. code:: bash
fzirob --help
to get an overview over all available commands.
.. |license_badge| image:: https://img.shields.io/github/license/fzi-forschungszentrum-informatik/robot_folders?color=yellow :alt: GitHub License
.. |codecov_badge| image:: https://codecov.io/gh/fzi-forschungszentrum-informatik/robot_folders/graph/badge.svg?token=85HNG0NCEI :target: https://codecov.io/gh/fzi-forschungszentrum-informatik/robot_folders .. |doc_badge| image:: https://img.shields.io/badge/Documentation-Github_Pages-blue :target: https://fzi-forschungszentrum-informatik.github.io/robot_folders/index.html