The master branch is now updated up to the fourth semester of work on this project. The documentation site is currently being deployed from that branch.
For current and future reference, there are three archive branches: semester-two-archive and semester-three-archive and 'semester-four'
This repository hosts the resources for a static-site generated by GitHub pages and Jekyll. The site is intended as a landing page for the project and a host for the project documentation resources. As such, the generated site contains both marketing-style information and detailed documentation. The documentation alone is the responsibility of project members.
The documentation is structured as follows:
Boldened content denotes semester three additions
Underlined content denotes pages that will be significantly modified during semester three
|-- Project organization
|-- Overview
|-- Design
|-- Implementation
|-- Testing
|-- Features
|-- Learning experience
|-- Adaptive module
|-- Achievements
|-- Grammatical error correction
|-- User experience
|-- Storytelling
|-- Visualizations
|-- Support
|-- Mission tasks
|-- Sentence correction
|-- Vocabulary guessing
|-- Discussion
|-- Listening
The site has undergone a number of structural changes between the second and third semester. You can find more details on this Mural board. For a detailed overview of our contributions for semester three, see this document.
Each group is responsible for the above-delegated section and each member must contribute an appropriate number of words for their project commitment.
Study project participants should contribute approximately 750 words each. Interdisciplinary participants should contribute approximately 500 words each.
Please create a new repository branch from the semester_three feature branch for each new page of the website (e.g. a testing branch for the testing documentation, a visualizations branch for the visualizations documentation, and so on). By 15 August 2021 each group must submit a pull request to merge their
branch with the semester_three branch and include in the pull request a comment which details the approximate word-count contributions of each project member. The pull requests will then be reviewed and merged. The final site will then be collectively reviewed before grading submission at the end of August.
Submitted Documentation (50)
- approx 500 words interdisciplinary, 750 words study project
- Formal aspects (length, scientific language, consistent formatting, proper referencing, good use of figures, screenshots etc.) (20)
- Clear description of implementation/conception/results (20)
- Discussion of limitations, possible additions (10)
As the site is deployed by GitHub Pages and generated with a Jekyll integration, we do not need to install Ruby or mess with css, we can directly modify Markdown files and quickly see the results on our site. As stated, group members are only responsible for the raw text/images of their documentation sections, but if you would like to modify the site template please raise this issue during a group meeting and we will implement a workflow to facilitate this change.
This GitHub pages site is based off the free template 'Spectral,' created by HTML5 UP and Andrew Banchich. Further information on this theme can be found here.
Installation on Linux is straightforward and well-enough explained on the official Jekyll site.
Windows
- Install ruby (devkit)
- Download msys from https://www.msys2.org/. Then follow the instructions to install the tools make, gcc and g++.
- Once the tools are installed, add the path to ruby and tools to your PATH (environment variables)
- C:\msys64\mingw64\bin
- C:\Ruby31-x64\bin
- You should be able to run
gcc -v,g++ -v, andmake -vsuccessfully - gem file needs to contain:
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]andgem "webrick"