Skip to content

Commit

Permalink
Reflect OS-specific nature of instructions in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mitchnegus committed Feb 4, 2025
1 parent 888c515 commit 42a877a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/source/install/prereqs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ System Dependencies
:start-after: dependencies-inclusion-marker
:end-before: dependencies-inclusion-stop

This section quickly outlines the system packages needed for full FIREWHEEL functionality with the exception of Python, discovery, minimega, git, and git-lfs as those are discussed in detail below.
Below is a brief outline of the system packages needed for full FIREWHEEL functionality with the exception of Python, discovery, minimega, git, and git-lfs as those are discussed in further detail in subsequent sections.

Full details about FIREWHEEL's dependencies be found in :ref:`firewheel-dependencies`.

Expand Down
6 changes: 4 additions & 2 deletions docs/source/install/prereqs/dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ System Dependencies
While FIREWHEEL is a Python package, it also depends on several system-level packages.
FIREWHEEL has been tested with the following operating systems:

* Ubuntu 16.04
* Ubuntu 18.04
* Ubuntu 20.04
* Ubuntu 22.04
* CentOS 7
* RHEL 8
* RHEL 9

However, the underlying system packages likely will work on all OSes.
The instructions provided in this documentation are tailored specifically for Ubuntu 22.04 and RHEL 9, although FIREWHEEL will likely be compatible with corresponding system packages on the majority of operating systems.

.. dependencies-inclusion-stop
Expand Down

0 comments on commit 42a877a

Please sign in to comment.