Skip to content

Commit 5336670

Browse files
authored
🔀 Merge pull request #337 from carpentries-incubator/issue-111
Improved setup instructions. Fixes #111.
2 parents bcaac51 + a5b5277 commit 5336670

1 file changed

Lines changed: 19 additions & 10 deletions

File tree

setup.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,14 @@
22
title: Setup
33
---
44

5-
You will need the following software installed and working correctly on your system to be able to follow the course.
5+
You will need the following software installed and working correctly on your system to be able
6+
to follow the course.
7+
8+
- [Command line tool](#command-line-tool) (such as **Bash**, **Zsh** or **Git Bash**)
9+
- [Git version control program](#git-version-control-tool)
10+
- [GitHub account](#github-account)
11+
- [Python 3 distribution](#python-3-distribution)
12+
- [PyCharm](#pycharm-ide) integrated development environment (IDE)
613

714
> ## Common Issues & Tips
815
> If you are having issues installing or running some of the tools below,
@@ -211,20 +218,22 @@ SSH key pair for authentication may seem complex, once set up, it is actually mo
211218
your access token.
212219
{: .callout}
213220

214-
## Python Distribution
215-
The material has been tested using the standard Python distribution version 3.11. The course is using `venv` for virtual
216-
environment management and `pip` for package management.
221+
## Python 3 Distribution
222+
223+
To download the latest Python 3 distribution for your operating system,
224+
please head to [Python.org](https://www.python.org/downloads/).
225+
226+
If you are on Linux,
227+
it is likely that the system Python 3 already installed will satisfy the requirements
228+
of this course (the material has been tested using the standard Python distribution version 3.11
229+
but any [supported version](https://devguide.python.org/versions/#versions) should work).
230+
231+
The course uses `venv` for virtual environment management and `pip` for package management.
217232
The material has not been extensively tested with other Python distributions and package managers,
218233
but most sections are expected to work with some modifications.
219234
For example, package installation and virtual environments would need to be managed differently, but Python script
220235
invocations should remain the same regardless of the Python distribution used.
221236

222-
To download the latest Python distribution for your operating system,
223-
please head to [Python.org](https://www.python.org/downloads/).
224-
If you are on Linux,
225-
it is likely that the system Python already installed will satisfy the requirements of this course.
226-
Check its version using the commands below.
227-
228237
>## Recommended Python Version
229238
> We recommend using the latest Python version but any [supported version](https://devguide.python.org/versions/#versions)
230239
> should work.

0 commit comments

Comments
 (0)