How2Code - "Better documentation and good practices in your codebase" ========yada

Material for the technical seminar of "Better documentation and good practices in your codebase"

(Find the corresponding materials in the ordered and enumerated directories, which should roughly follow the timeline of the presentation.)

---

Necessary tools to install to follow along

Docker

1. Add Docker's official GPG key:

sudo apt-get update

sudo apt-get install ca-certificates curl

sudo install -m 0755 -d /etc/apt/keyrings

sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc

sudo chmod a+r /etc/apt/keyrings/docker.asc

---

2. Add the repository to Apt sources:

echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

sudo apt-get update

3. Install Docker and the dependencies

sudo apt-get install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

4. Run the hello-world installation test

sudo docker run hello-world

---

Anaconda

wget https://repo.anaconda.com/archive/Anaconda3-2023.09-0-Linux-x86_64.sh

chmod +x Anaconda3-2023.09-0-Linux-x86_64.sh

./Anaconda3-2023.09-0-Linux-x86_64.sh

Following the instructions of the installer on the command line, you should give "yes" to all the questions.

---

Git

sudo apt-get install -y git

---

VsCode

• 1. Download the ".deb" file from Download VsCode
• 2. Run the downloaded ".deb" file.

---