Initial revision.

cawnj · Sep 10, 2021 · 8a3938a · 8a3938a
commit 8a3938a
Show file tree

Hide file tree

Showing 9 changed files with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# CA326 template repo
+
+This is a template for CA326 projects.
+
+## 1. Create your repo
+
+One person from your project team should fork this repo, then add other teammates as project members on GitLab.
+
+## 2. Name your repo appropriately
+
+The name of your project must be of the form `2022-ca326-XXXXXXX`, where "`XXXXXXX`"
+should be replaced with your usernames (e.g. `2022-ca326-sblott-pclarke`).
+
+**Note** that the year should be set as appropriate to your year of study. For example, in the
+2022/2023 academic year this would change to '2023-ca326-sblott-pclarke'),
+in the 2023/2024 academic year this would change to '2024-ca326-sblott-pclarke'), etc.
+
+It is the *name of your repo* which matters (not the name of your project).
+
+You can change the name of your repo on GitLab under:
+
+- Settings / General / Advanced / Change path
+
+It looks like this:
+
+![change-repo-path](./res/repo-change-path.png "Change repo path.")
+
+You should replace all of this file with a README describing your own project.
diff --git a/docs/.gitkeep b/docs/.gitkeep
diff --git a/docs/1-proposal/.gitkeep b/docs/1-proposal/.gitkeep
diff --git a/docs/2-functional-specification/.gitkeep b/docs/2-functional-specification/.gitkeep
diff --git a/docs/3-final-reports/.gitkeep b/docs/3-final-reports/.gitkeep
diff --git a/docs/README.txt b/docs/README.txt
@@ -0,0 +1 @@
+All documentation goes in or under this directory.
diff --git a/res/README.md b/res/README.md
@@ -0,0 +1 @@
+Miscellaneous resources can go here.
diff --git a/res/repo-change-path.png b/res/repo-change-path.png
diff --git a/src/.gitkeep b/src/.gitkeep
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		All documentation goes in or under this directory.