From 52219045aa2eb25683df376a4ec29c21427cd612 Mon Sep 17 00:00:00 2001 From: Matt Bovel <matthieu@bovel.net> Date: Wed, 23 Feb 2022 15:27:12 +0100 Subject: [PATCH] Update tools-setup.md --- labs/tools-setup.md | 80 ++++++--------------------------------------- 1 file changed, 10 insertions(+), 70 deletions(-) diff --git a/labs/tools-setup.md b/labs/tools-setup.md index a1f85aa..c634853 100644 --- a/labs/tools-setup.md +++ b/labs/tools-setup.md @@ -18,71 +18,11 @@ and fill in [this form](https://forms.gle/N6F3Q3jZm71AASby9) with your GASPAR an ## Step 2: Installing the Java Development Kit (JDK) and sbt via coursier We will use coursier to install the correct version of -Java as well as the sbt build tool: +Java as well as the sbt build tool. Follow [the instructions on the coursier website](https://get-coursier.io/docs/cli-installation) for the installation. -### On Linux and macOS +_Note_: on Windows, you might have to run the installer twice. -```shell -curl -fLo cs https://git.io/coursier-cli-"$(uname | tr LD ld)" -``` -```shell -chmod +x cs -``` -```shell -./cs setup -y --jvm 8 --apps cs,sbt -``` - -Please reboot after this point. - -### On Windows - -Download and install both the [Visual C++ 2010 SP1 Redistributable -Package](https://www.microsoft.com/en-us/download/details.aspx?id=26999) and [Visual C++ 2015 Redistributable Update](https://www.microsoft.com/en-us/download/details.aspx?id=52685) (click -on "Download" then select "vcredist_x64.exe" and click "Next"). - -Open `cmd.exe` (and not powershell) - -First, make sure that you are not in the `System32` directory, instead you -should be in `C:\Users\yourusername`. If you are in `System32` you will need to -change directory to your user directory every time you start a terminal by -running: -```shell -cd %USERPROFILE% -``` - -Now assuming that you're in the correct directory you can run: - -```shell -bitsadmin /transfer cs-cli https://git.io/coursier-cli-windows-exe "%cd%\cs.exe" -``` -```shell -.\cs setup -y --jvm 8 --apps cs,sbt -``` - -(This command might cause your anti-virus to misidentify cs.exe as a virus, -please override that, that might require temporarily turning off your anti-virus -during this setup). - -If this command fails with `Error running powershell script`, use the following -alternative instructions (if the command didn't fail, continue to the next -step): - -1. Run `.\cs setup --jvm 8 --apps cs,sbt`, at every question answer "n" and - press Enter. -2. The last question should look like "Should we add `C:\...\bin` to your PATH?", - please copy the `C:\...\bin` part here. -3. Edit the Path environment variable and paste the path you just copied to it, see - https://www.architectryan.com/2018/08/31/how-to-change-environment-variables-on-windows-10/ - and make sure the path you're adding is the first entry in the Path environment - variable. -4. Start a **new** cmd.exe and continue with the rest of the instructions - -**In case of errors please ask on Discord or Gitlab issues for help, but don't -try to run commands as Administrator as this will likely cause further issues!** - -Please close this terminal and open a new one after this point. - -## Step 5: Installing git +## Step 3: Installing git git is a version control system. @@ -117,7 +57,7 @@ git config --global core.autocrlf false If this command worked it will not print anything. -## Step 6: Installing Code +## Step 4: Installing Code Visual Studio Code is the IDE we strongly recommend using for this class (you are free to use any editor you want, but we won't don't have the resources to help you configure it for Scala). @@ -140,7 +80,7 @@ See [https://code.visualstudio.com/docs/setup/windows](https://code.visualstudio Make sure that the checkbox "Add to PATH (available after restart)" in the installer is checked. -## Step 7: Installing the Scala support for Code +## Step 5: Installing the Scala support for Code Open a **new** terminal and run: ```scala @@ -150,11 +90,11 @@ code --install-extension lampepfl.dotty-syntax If you're on Windows and the command is not found, try closing and restarting the terminal, if that doesn't work -## Step 8: Generate a public/private SSH key pair +## Step 6: Generate a public/private SSH key pair To submit labs, you will need an SSH key. If you don't already have one, here's how to generate it: -### Step 8.1: Installing OpenSSH +### Step 6.1: Installing OpenSSH #### On Ubuntu and Debian @@ -171,17 +111,17 @@ Nothing to do, OpenSSH is pre-installed Follow the instructions under "Enable OpenSSH Client in Windows 10" on [https://winaero.com/blog/enable-openssh-client-windows-10/](https://winaero.com/blog/enable-openssh-client-windows-10/) -### Step 8.2: Generating the key pair +### Step 6.2: Generating the key pair Please follow [this tutorial](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) to generate a new SSH key and add it to the ssh-agent (except the last step: you should instead add the key to Gitlab as described below). This [video](https://youtu.be/_RsP81Et12s?t=67) (from 1:07 to 4:05) might also help. -### Step 8.3: Adding your public key on Gitlab +### Step 6.3: Adding your public key on Gitlab To be able to push your code, you'll need to add the public part of your key on Gitlab: - Go to [gitlab.epfl.ch](https://gitlab.epfl.ch), log in with your EPFL account - Go to [gitlab.epfl.ch/-/profile/keys](https://gitlab.epfl.ch/-/profile/keys) and copy-paste the content of the `id_rsa.pub` file created by the `ssh-keygen` command you just ran (`ssh-keygen` prints the location of the file to the console). - Press `Add key` -## Step 9: Follow the example lab +## Step 7: Follow the example lab Time to do the [example lab](example-lab.md)! -- GitLab