Merge pull request #11 from github/template-readme

Update template README to detail what needs to be replaced.

Author: s0

README.md

@@ -159,7 +159,7 @@ FROM docker.pkg.github.com/github/codeql-learninglab-actions/codeql-learninglab-
 COPY --chown=codeql:codeql config /home/codeql/config
 WORKDIR /home/codeql/config
 # Download, unzip and then delete the zip file in one step to reduce image size
-RUN wget --quiet <url-for-snapshot-zip> -O snapshot.zip && unzip -qq snapshot.zip && rm -rf snapshot.zip
+RUN wget --quiet <url-for-snapshot-zip> -O database.zip && unzip -qq database.zip && rm -rf database.zip
 ```
 
 Note that we download, unzip and then delete the zip file of the snapshot

courses/cpp/ctf-segv/image/Dockerfile

@@ -4,4 +4,4 @@ FROM docker.pkg.github.com/github/codeql-learninglab-actions/codeql-learninglab-
 COPY --chown=codeql:codeql config /home/codeql/config
 WORKDIR /home/codeql/config
 # Download, unzip and then delete the zip file in one step to reduce image size
-RUN wget --quiet https://downloads.lgtm.com/snapshots/cpp/GNU/glibc/bminor_glibc_cpp-srcVersion_333221862ecbebde60dd16e7ca17d26444e62f50-dist_odasa-lgtm-2019-04-08-af06f68-linux64.zip -O snapshot.zip && unzip -qq snapshot.zip && rm -rf snapshot.zip
+RUN wget --quiet https://downloads.lgtm.com/snapshots/cpp/GNU/glibc/bminor_glibc_cpp-srcVersion_333221862ecbebde60dd16e7ca17d26444e62f50-dist_odasa-lgtm-2019-04-08-af06f68-linux64.zip -O database.zip && unzip -qq database.zip && rm -rf database.zip

courses/template/README.md

@@ -3,4 +3,17 @@
 Copy this entire directory,
 and replace the following:
 
-* TODO
+* Replace `<owner>`, `<repo>` and `<pkg>` in the `image` property in
+  [`action.yml`](action.yml) to reference the correct repository
+  where the docker image will be published,
+  and with a package name of your choice.
+  (For courses in this repository,
+  we use the convention of taking the course path,
+  and replacing slashes with dashes,
+  e.g. `courses/cpp/ctf-segv` becomes `courses-cpp-ctf-segv`)
+* Replace the zip file URL in [`image/Dockerfile`](image/Dockerfile)
+  to point to the CodeQL database that will be used in your course.
+
+After this,
+update [`answers/`](answers) and [`image/config/`](image/config)
+to add your model answers and expected query results as appropriate.

courses/template/image/Dockerfile

@@ -4,4 +4,4 @@ FROM docker.pkg.github.com/github/codeql-learninglab-actions/codeql-learninglab-
 COPY --chown=codeql:codeql config /home/codeql/config
 WORKDIR /home/codeql/config
 # Download, unzip and then delete the zip file in one step to reduce image size
-RUN wget --quiet https://downloads.lgtm.com/snapshots/cpp/GNU/glibc/bminor_glibc_cpp-srcVersion_333221862ecbebde60dd16e7ca17d26444e62f50-dist_odasa-lgtm-2019-04-08-af06f68-linux64.zip -O snapshot.zip && unzip -qq snapshot.zip && rm -rf snapshot.zip
+RUN wget --quiet https://downloads.lgtm.com/snapshots/cpp/GNU/glibc/bminor_glibc_cpp-srcVersion_333221862ecbebde60dd16e7ca17d26444e62f50-dist_odasa-lgtm-2019-04-08-af06f68-linux64.zip -O database.zip && unzip -qq database.zip && rm -rf database.zip