Skip to content

Commit

Permalink
docs: getting started - git prereq
Browse files Browse the repository at this point in the history
  • Loading branch information
thekaveman committed Dec 11, 2024
1 parent 233cb18 commit 264cd4b
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion docs/development/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Getting started
# Getting started with development

!!! info

Expand All @@ -9,6 +9,25 @@

This section describes the tooling you need to have installed and configured on your development machine before continuing.

### Git

Git is an open source version control system that we use in `pems` to track changes to the codebase over time. Many operating
systems come with Git already installed. Check if you have Git installed in a terminal with the following command:

```shell
git --version
```

If git is installed, the output should look similar to:

```console
$ git --version
git version 2.39.5
```

If Git is not installed, head to the [Git downloads page](https://git-scm.com/downloads) to get an installer for your operating
system.

### Docker and Docker Compose

Docker and Docker Compose (or just Compose) are key tools that allow for running the various services required for `pems`.
Expand Down

0 comments on commit 264cd4b

Please sign in to comment.