Skip to content

Commit

Permalink
Update setup.rst
Browse files Browse the repository at this point in the history
Update instructions to include Fedora as a supported platfom and to link to the most relevant instructions on the docker site.
  • Loading branch information
jiceatscion authored Jul 27, 2023
1 parent 09b5dea commit e4ee5b1
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions doc/dev/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,19 @@ Setting up the Development Environment
Prerequisites
-------------

#. Make sure that you are using a clean and recently updated **Ubuntu 18.04**.
Other Ubuntu versions (or systems) will usually be fine too, but some of the tooling may not work.
#. Make sure that you are using a clean and recently updated linux distribution. Distributions that are
nown to work are:

* **Ubuntu** release 18 or later.
* **Fedora** release 38 or later.
* **Amazon** Linux 2.

Other Linux environments will usually be fine too, but some of the tooling might need
tweaking. If you make things work for other distributions, please update this list.

This environment assumes you're running as a non-root user with ``sudo`` access.
#. Install ``docker``.
Please follow the instructions for `docker-ce <https://docs.docker.com/install/linux/docker-ce/ubuntu/>`_.
Please follow the instructions for `docker server <https://docs.docker.com/engine/install/#server>`_.
Then, add your user to the ``docker`` group:
``sudo usermod -a -G docker ${LOGNAME}``, where ``${LOGNAME}`` is replaced with your user name. Log out
and log back in so that your membership of the ``docker`` group is seen by the shell session.
Expand Down

0 comments on commit e4ee5b1

Please sign in to comment.