Copy of legacy template repo.

README.md

@@ -0,0 +1,37 @@
+# CA400 template repo
+
+This is a template for CA400 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-ca400-XXXXXXX`, where "`XXXXXXX`"
+should be replaced with your usernames (e.g. `2022-ca400-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-ca400-sblott-pclarke'), 
+in the 2023/2024 academic year this would change to '2024-ca400-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.
+
+## Additional resources
+
+- Repo [hygiene](https://gitlab.computing.dcu.ie/sblott/local-gitlab-documentation/blob/master/repo-hygiene.md)
+- Git [cheat sheet](https://gitlab.computing.dcu.ie/sblott/local-gitlab-documentation/blob/master/cheat-sheet.md)
+- Gitlab [CI environment](https://gitlab.computing.dcu.ie/sblott/docker-ci-environment) and it's [available software](https://gitlab.computing.dcu.ie/sblott/docker-ci-environment/blob/master/Dockerfile)
+- Example projects with CI configured:
+   * [Python](https://gitlab.computing.dcu.ie/sblott/test-project-python)
+   * [Java](https://gitlab.computing.dcu.ie/sblott/test-project-java)
+   * [MySql](https://gitlab.computing.dcu.ie/sblott/test-project-mysql)

build/README.md

@@ -0,0 +1,7 @@
+Put build files here.
+
+These files are automatically generated, and *should not* be committed to
+your repo.
+
+(This optional.  Sometimes your build system will have its own idea of the
+best location for build files.)

docs/README.md

@@ -0,0 +1,15 @@
+All of your documentation should be placed in subdirectories of this directory.
+
+- Use the `proposal` sub-directory for your project proposal.
+- Use the `functional-spec` sub-directory for your functional specification.
+- Use the `documentation` sub-directory for your user manual and technical documentation.
+- Use the `video-walk-through` sub-directory for you video walk through.
+
+There are additional instructions in each of those sub-directories.  Please read them.
+
+** Excluding the proposal document, The general rule of thumb that you should 
+adopt is that documents should be converted to PDF when finalised - and
+available for collection from your repo in time for the appropriate deadlines.
+While templates are provided in MS Word format, individual students may select
+whichever editing software they prefer - the only constraint is that
+the final revision of these documents should be converted to PDF.**

docs/documentation/README.md

@@ -0,0 +1,17 @@
+Place your user manual and technical documentation in this directory.
+
+PDF is the preferred format.
+
+The first page of each document should contain at least:
+
+- your names,
+- your project title,
+- the type of document (e.g. *Technical Manual*)
+- your student IDs, and
+- the date you finished working on the document.
+
+In addition, the file names you choose to use should make clear what the document content is.
+
+**The final version of your documents should be converted to PDF and stored in this same directory**
+
+*Do not place any other files in this directory.*

docs/functional-spec/README.md

@@ -0,0 +1,15 @@
+Place your functional specification in this directory.
+
+A general template for the functional specification (in MS Word format) is located in this directory. 
+
+The first page of your functional specification should contain at least:
+
+- your names,
+- your project title,
+- the type of document (e.g. *Functional Specification*)
+- your student IDs, and
+- the date you finished working on the document.
+
+**When it comes to actual submission, you should create a PDF copy of your final version and store it in this directory also.**
+
+*Do not place any other files in this directory.*

docs/proposal/proposal.md

@@ -0,0 +1,95 @@
+# School of Computing — Year 4 Project Proposal Form
+
+> Edit (then commit and push) this document to complete your proposal form.
+> Make use of figures / diagrams where appropriate.
+>
+> Do not rename this file.
+
+## SECTION A
+
+|                     |                   |
+|---------------------|-------------------|
+|Project Title:       | xxxxxx            |
+|Student 1 Name:      | xxxxxx            |
+|Student 1 ID:        | xxxxxx            |
+|Student 2 Name:      | xxxxxx            |
+|Student 2 ID:        | xxxxxx            |
+|Project Supervisor:  | xxxxxx            |
+
+> Ensure that the Supervisor formally agrees to supervise your project; this is only recognised once the
+> Supervisor assigns herself/himself via the project Dashboard.
+>
+> Project proposals without an assigned
+> Supervisor will not be accepted for presentation to the Approval Panel.
+
+## SECTION B
+
+> Guidance: This document is expected to be approximately 3 pages in length, but it can exceed this page limit.
+> It is also permissible to carry forward content from this proposal to your later documents (e.g. functional
+> specification) as appropriate.
+>
+> Your proposal must include *at least* the following sections.
+
+
+### Introduction
+
+> Describe the general area covered by the project.
+
+### Outline
+
+> Outline the proposed project.
+
+### Background
+
+> Where did the ideas come from?
+
+### Achievements
+
+> What functions will the project provide? Who will the users be?
+
+### Justification
+
+> Why/when/where/how will it be useful?
+
+### Programming language(s)
+
+> List the proposed language(s) to be used.
+
+### Programming tools / Tech stack
+
+> Describe the compiler, database, web server, etc., and any other software tools you plan to use.
+
+### Hardware
+
+> Describe any non-standard hardware components which will be required.
+
+### Learning Challenges
+
+> List the main new things (technologies, languages, tools, etc) that you will have to learn.
+
+### Breakdown of work
+
+> Clearly identify who will undertake which parts of the project.
+>
+> It must be clear from the explanation of this breakdown of work both that each student is responsible for
+> separate, clearly-defined tasks, and that those responsibilities substantially cover all of the work required
+> for the project.
+
+#### Student 1
+
+> *Student 1 should complete this section.*
+
+#### Student 2
+
+> *Student 2 should complete this section.*
+
+## Example
+
+> Example: Here's how you can include images in markdown documents...
+
+<!-- Basically, just use HTML! -->
+
+<p align="center">
+  <img src="./res/cat.png" width="300px">
+</p>
+

docs/video-walk-through/README.md

@@ -0,0 +1,13 @@
+<!--
+The video walk through is [here](FIX-ME).
+-->
+
+Instructions:
+
+1. Upload your video walk through to Google Drive.
+2. Under sharing, allow anyone with the link to view the video.
+3. Place a link to the video above, and uncomment those lines.
+4. `git commit -a`, `git push`.
+5. Using incognito mode on your browser, verify that the video is indeed accessible to anybody with the link.
+
+Remember that **your video duration is limited to an maximum of 5 minutes.**   

res/README.md

@@ -0,0 +1 @@
+Miscellaneous resources can go here.

src/README.md

@@ -0,0 +1 @@
+All of your source code (and other program resources) should be placed in this sub-directory.