From e2dd6011ad2abcec220220f14efdb451c986aea3 Mon Sep 17 00:00:00 2001 From: Andrea Censi Date: Tue, 22 Feb 2022 13:54:04 +0100 Subject: fix --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..bf98d63 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ + + +## Setup + +Install VS Code. + +Select File -> Open and select *the entire folder*. + +VS Code will give you a message similar to: + +> Folder contains a Dev Container configuration file. Reopen folder to develop in a container. + +Select "Reopen in container". + +Now you should have the folder open while VS Code is in "container development mode". + +Create a new terminal using Terminal -> New Terminal. + +Run the following: + + make check-TestSimpleIntro + +This will have created a file `out-results/result-TestSimpleIntro.html`. + +From the file tree to the left, right-click the file and select "open preview". You will see the results of the testing. + +Now browse the Python files in `src/`. Verify that autocompletion works.. + + + -- cgit v1.2.1 From d33763817e7501bd2ff81f7d5da1900c9d15c8d2 Mon Sep 17 00:00:00 2001 From: Gioele Zardini <32289677+gzardini@users.noreply.github.com> Date: Tue, 22 Feb 2022 14:04:08 +0100 Subject: Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index bf98d63..5bb6b79 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ Install VS Code. Select File -> Open and select *the entire folder*. +VS Code will propose to install "Dev Container". Click "install". + VS Code will give you a message similar to: > Folder contains a Dev Container configuration file. Reopen folder to develop in a container. -- cgit v1.2.1 From 8ea0a108552c7688682fd03e18ed9595350c5272 Mon Sep 17 00:00:00 2001 From: Gioele Zardini <32289677+gzardini@users.noreply.github.com> Date: Tue, 1 Mar 2022 08:47:02 +0100 Subject: Update README.md added docker installation --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5bb6b79..c3c8796 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,14 @@ ## Setup -Install VS Code. +### Install Docker +> (Mac, Linux) Follow the [installation instructions](https://docs.docker.com/get-docker/) +> (Windows): +>> Follow the manual installation steps for Windows Subsystem for Linux [here](https://docs.microsoft.com/en-us/windows/wsl/install). On step 1, follow the recommendation of updating to WSL 2. On step 6, you can download Ubuntu 18.04 LTS. You do not necessarily need to install Windows Terminal. +>> Now go [here](https://docs.docker.com/desktop/windows/install/) and follow the "Install Docker Desktop on Windows" instructions. You can then start Docker Desktop and follow the quick start quide. + + +### Install VS Code. Select File -> Open and select *the entire folder*. -- cgit v1.2.1 From e0907806400801df87bf8ffb7a8858def82f3d32 Mon Sep 17 00:00:00 2001 From: Gioele Zardini <32289677+gzardini@users.noreply.github.com> Date: Tue, 1 Mar 2022 08:49:13 +0100 Subject: Update README.md --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c3c8796..6c531e1 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,14 @@ ## Setup ### Install Docker -> (Mac, Linux) Follow the [installation instructions](https://docs.docker.com/get-docker/) -> (Windows): ->> Follow the manual installation steps for Windows Subsystem for Linux [here](https://docs.microsoft.com/en-us/windows/wsl/install). On step 1, follow the recommendation of updating to WSL 2. On step 6, you can download Ubuntu 18.04 LTS. You do not necessarily need to install Windows Terminal. ->> Now go [here](https://docs.docker.com/desktop/windows/install/) and follow the "Install Docker Desktop on Windows" instructions. You can then start Docker Desktop and follow the quick start quide. + + + ### Install VS Code. -- cgit v1.2.1 From 3b3932e24e86a169bafdf9d12f50d339c2542c3e Mon Sep 17 00:00:00 2001 From: Gioele Zardini <32289677+gzardini@users.noreply.github.com> Date: Tue, 1 Mar 2022 08:49:44 +0100 Subject: Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 6c531e1..2da0866 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@