Skip to content

Commit

Permalink
update to use page titles for links and minor formatting changes
Browse files Browse the repository at this point in the history
  • Loading branch information
TimidRobot committed Jul 18, 2024
1 parent 6acf363 commit 2f6bac4
Showing 1 changed file with 21 additions and 16 deletions.
37 changes: 21 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,27 +87,30 @@ the data repository (the codebases) be cloned next to each other.

#### MacOS

Mac users can install Git using [these instructions][macos-git].
Mac users can install Git using these instructions: [Git - Installing Git -
Installing on macOS][macos-git].

Docker Desktop can be installed using [these instructions][macos-docker].
Docker Desktop can be installed using these instructions: [Install Docker
Desktop on Mac | Docker Docs][macos-docker].

[macos-git]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git#_installing_on_macos
[macos-docker]: https://docs.docker.com/desktop/install/mac-install


#### Linux

Git is optimally installed using your distribution's package manager.
See [these commands][linux-git] for a wide range of popular distros.
Git is optimally installed using your distribution's package manager. See [Git
- Download for Linux and Unix][linux-git] for a wide range of popular distros.

Both Docker Desktop and Docker Engine are separately supported on Linux.
Both include the required Compose command plugin, but Docker Engine is
typically much easier to install.

The [Docker CE resource][linux-docker-engine] links to installation
instructions for Docker Engine and Compose for various Linux distributions.
[Linux Docker Desktop][linux-docker-desktop] links to instructions for the
graphical desktop app that includes the commandline interface and Compose.
typically much easier to install:
- _Recommended:_ See [Install Docker Engine | Docker Docs][linux-docker-engine]
for links to installation instructions for Docker Engine and Compose for
various Linux distributions.
- See [Install Docker Desktop on Linux | Docker
Docs][linux-docker-desktop] for links to instructions for the graphical
desktop app that includes the commandline interface and Compose

[linux-git]: https://git-scm.com/download/linux
[linux-docker-engine]: https://docs.docker.com/engine/install
Expand All @@ -116,14 +119,16 @@ graphical desktop app that includes the commandline interface and Compose.

#### Windows

You must use Windows 10 or 11 with [Windows Subsystem for Linux (WSL2)][wsl2].
You must use Windows 10 or 11 with Windows Subsystem for Linux (WSL2). For
installation instructions: see [Install WSL | Microsoft Learn][wsl2].

Git should be installed within WSL2, using the appropriate Linux installation
method. For WSL2 Ubuntu, the command is `sudo apt-get install git`.

Docker Desktop should be installed on Windows itself and integrated with WSL2 as
explained in [these instructions][docker-wsl2]. Unlike Git, you should not
install Docker within your WSL2 environment.
Docker Desktop should be installed on Windows itself and integrated with WSL2
as explained in [Docker Desktop WSL 2 backend on Windows | Docker
Docs][docker-wsl2]. Unlike Git, you should not install Docker within your WSL2
environment.

[wsl2]: https://docs.microsoft.com/en-us/windows/wsl/install
[docker-wsl2]: https://docs.docker.com/desktop/windows/wsl
Expand Down Expand Up @@ -158,8 +163,8 @@ To achieve this, we recommend the following procedure:
git clone https://github.com/creativecommons/cc-legal-tools-data.git
```

Visit [Cloning a Repository][gitclone] for more on how to clone a GitHub
repository.
Visit [Cloning a repository - GitHub Docs][gitclone] for more on how to clone a
GitHub repository.

[gitclone]:https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository

Expand Down

0 comments on commit 2f6bac4

Please sign in to comment.