Skip to content

Commit c00d266

Browse files
A trivial update of the intro README.md
1 parent b0220ef commit c00d266

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This is the source material for the [analysis essentials website][website], a
55
series of lessons for helping high-energy physics analysts become more
66
comfortable working with the shell, version control, and programming.
77

8-
The lessons introduce the basics of the bash shell, the git version control
8+
The lessons introduce the basics of the bash shell, the Git version control
99
system, and the Python programming language. They are developed for and taught
1010
during the [Starterkit][starterkit], and aim to teach students enough to be
1111
able to follow the experiment-specific lessons that are taught afterwards.
@@ -23,13 +23,14 @@ as they enter the field, and in parallel, instill best practices for writing sof
2323

2424
## Prerequisites
2525

26-
There are two options for running these lessons. Running locally should be prefered on Linux and macOS as it is faster and makes it easier to save you work. On Windows it is likely easier to use Binder however care is needed to prevent notebooks being lost when the server is shut down.
26+
There are two options for running these lessons. Running locally should be prefered on Linux and macOS as it is faster and makes it easier to save you work.
27+
On Windows it is likely easier to use Binder; however, care is needed to prevent notebooks from being lost when the server is shut down.
2728

2829
### Local
2930

3031
This tutorial uses `Python 3.11` and requires some packages.
3132
It is recommended to use [mambaforge](https://github.com/conda-forge/miniforge#mambaforge) to install the correct packages.
32-
**Note:** `mamba` is like `conda` and can be used interchangeably. "forge" in the name refers to the [conda-forge](https://conda-forge.org/) channel, _the_ open-source maintained channel which contains a lot of packages.
33+
**Note:** `mamba` is like `conda` and can be used interchangeably. "forge" in the name refers to the [conda-forge](https://conda-forge.org/) channel, _the_ open-source maintained channel that contains a lot of packages.
3334

3435
To install `Conda`/`mamba` you will need to do the following:
3536

@@ -59,7 +60,7 @@ mamba create -n analysis-essentials python=3.11 jupyterlab ipython matplotlib up
5960

6061

6162
You will also need [Jupyter](https://jupyterlab.readthedocs.io/) to run the examples in this tutorial.
62-
Jupyter was already installed in the previous command and can be ran by following the instructions [here](https://jupyterlab.readthedocs.io/en/stable/getting_started/starting.html).
63+
Jupyter was already installed in the previous command and can be run by following the instructions [here](https://jupyterlab.readthedocs.io/en/stable/getting_started/starting.html).
6364
Note: You **will** need Python.
6465

6566
### Binder
@@ -69,11 +70,11 @@ Click this button: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybi
6970
## Usage
7071

7172
You should now be able to use the tutorial.
72-
- First clone with git:
73+
- First clone with Git:
7374
```bash
7475
git clone https://github.com/hsf-training/analysis-essentials.git
7576
```
76-
- For more information on getting started with git please see the [Analysis Essentials course](https://hsf-training.github.io/analysis-essentials/index.html)
77+
- For more information on getting started with Git please see the [Analysis Essentials course](https://hsf-training.github.io/analysis-essentials/index.html)
7778
```bash
7879
cd analysis-essentials
7980
jupyter lab

0 commit comments

Comments
 (0)