CS3028 Team Charlie

Charlie team repository, Law in the Aberdeen Council Registers 1398-1511

The repository structure is roughly modelled on the structure of GNU coreutils, in the hope that it's familiar, with a few changes:

Getting Started

Install Docker

• Debian
• Ubuntu
• Linux Mint
• Arch linux

Install docker-compose

• Using pip

pip install docker-compose

Navigate to CS3028-CHARLIE/src and execute start

cd src
./start

Repository contents:

• /coursework - Contains the coursework for the project
• /coursework/Presentations - Contains any presentations we may give
• /doc - Project documentation - the "user-facing" documentation - how things work, etc
• /doc-internal - Internal-use documentation - documentation for use whilst building the project - TEI documentation, for example
  • /doc-internal/TEI - Internal documentation pertaining to TEI
  • /doc-internal/TEI/Guidlines.pdf - The official TEI Guidlines
  • /doc-internal/TEI/TEI.table - A table of the TEI tags we'll be using in the project
• /src - Project source code