Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link to pages docs #13

Merged
merged 2 commits into from
May 15, 2024
Merged

Link to pages docs #13

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
030c2ad
Link to pages docs
fmauch May 15, 2024
bfd11ac
fix link formatting
fmauch May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ It focuses on optimizing the management of various subworkspaces, contributing
to a seamless development experience.


Documentation
-------------
Documentation can be found on `our GH pages <https://fzi-forschungszentrum-informatik.github.io/robot_folders/>`_.


Quick start
------------

Expand All @@ -21,7 +26,7 @@ install pipx``). Please note: With pipx versions < 1.0 you'll have to provide th
pipx install robot_folders

Upgrade
-------
^^^^^^^

To upgrade robot_folders using ``pipx`` do

Expand All @@ -30,7 +35,7 @@ To upgrade robot_folders using ``pipx`` do
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.
Expand All @@ -53,7 +58,7 @@ In case you manually installed ``robot_folders`` using a python virtualenv the p


Basic usage
-----------
^^^^^^^^^^^

After installation open up a new terminal to use robot_folders. The main
command for using robot_folders is ``fzirob``. Type
Expand Down
Loading