GitXplorerGitXplorer
r

game-of-life

public
0 stars
0 forks
0 issues

Commits

List of commits on branch master.
Verified
eaae6d461bfe109ee2a7b4c97582263caf6291da

Merge pull request #43 from robzwolf/feature/submission

rrobzwolf committed 4 years ago
Unverified
c73dd2145450fa8a916b628516b8a35a94dde62d

Use 20-page report

rrobzwolf committed 4 years ago
Unverified
6306550383aff4da7a30b8b1045bdc3dae9e3dc0

Add submission files as .zip

rrobzwolf committed 4 years ago
Unverified
173ad6d305643113d88970bfa19d8511c1906e66

Copy relevant files for submission to separate folder

rrobzwolf committed 4 years ago
Unverified
928ebfd8be76af6ac3ec4d39fd32ccede78f5edc

Add link to final report in README

rrobzwolf committed 4 years ago
Unverified
a330140233461b0a035ad0a04677ebb6260b1020

Add project report PDF

rrobzwolf committed 4 years ago

README

The README file for this repository.

Game of Life

Level 3 Computer Science project at Durham University, by Robbie Jakob-Whitworth.

This project is about investigating different techniques for visualising and simulating Conway's Game of Life.

For further details about objectives, deliverables, and the research question, see the Project Plan.

Quick Start

Implementation 1 (Vanilla JS)

See src/implementation-1/README.md.

Implementation 2 (React)

See src/implementation-2/README.md.

Implementation 3 (node.js)

See src/implementation-3/README.md.

Documents

Relevant documents are stored in both formats in this repository:

  • An editable source
  • A final, published PDF

Editable documents are stored in Documents/Source.

Final, published files are stored in Documents/Final.

Relevant documents are as follows:

File Editable File Published File
Project Plan Project Plan.md Project Plan.pdf
Literature Survey Literature Survey (Google Docs) Literature Survey.pdf
Final Report Final Report (Google Docs) Project Report.pdf

Converting a Document from GitHub-Flavoured Markdown to PDF

The following slightly convoluted steps produce a clean PDF from a GitHub-flavoured markdown file.

  1. Open the markdown file in Atom, a free text editor.
  2. Once in Atom, open a preview of the markdown file by pressing Ctrl+Shift+M.

    This is the same key combination on both Windows and macOS.

  3. With the focus on the preview window, save the preview as an HTML file.

    +Shift+S

  4. Open the saved HTML file in Google Chrome, and use its Save as PDF feature.

    Set the scale to 70% for optimum, consistent visual results.

Meeting Notes

For each meeting with the supervisor, copy the file Documents/Meeting Notes/TEMPLATE.md and save it as a new file, with the date of the meeting in ISO8601 format (e.g. 2019-12-25).

Meeting notes can be found in the Documents/Meeting Notes directory.

Deploy Previews

Check the issues tab on GitHub to find preview URLs for each relevant branch.

Adding a New Preview URL for a New Branch

If creating a new branch, e.g. feature/zeroth-implementation, add the following to the netlify.toml file on the master branch of this repo.

[context."feature/zeroth-implementation"]  # Contains the branch name
    base = "src/implementation-0/"         # The directory for that implementaiton
    publish = "public/"                    # The directory to publish, relative to the base directory
    command = "npm i && npm run build"     # Build command to run, in the base directory

Netlify will then automatically pick up the new branch upon push and will deploy it.

You should manually add a new issue to GitHub with the preview-url label and a link to the preview URL for that branch.