summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorgithub-classroom[bot] <66690702+github-classroom[bot]@users.noreply.github.com>2023-10-04 16:42:46 +0200
committerGitHub <noreply@github.com>2023-10-04 16:42:46 +0200
commitccdbbb4716b240c3e5aa4c3389dcd92e142df22e (patch)
tree7335976fc7bb1b79d8b8812886f94715fe59ed95 /README.md
downloadact4e-ccdbbb4716b240c3e5aa4c3389dcd92e142df22e.tar.gz
act4e-ccdbbb4716b240c3e5aa4c3389dcd92e142df22e.zip
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c24aaf4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+## Setup
+
+### Install Docker
+
+<ul>
+ <li> (Mac, Linux) Follow the [installation instructions](https://docs.docker.com/get-docker/) </li>
+ <li>(Windows):
+ <ul>
+ <li>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. </li>
+ <li>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.</li>
+ </ul>
+ </li>
+ </ul>
+
+### 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.
+
+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:
+
+ act4e-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..
+
+
+