Assignment #1

Name: Mo Khan
Student ID: 3431709

This project uses [maven](https://maven.apache.org) as the primary build tool.
[rake](https://github.com/ruby/rake) is used as a
secondary build tool to drive the [maven](https://maven.apache.org) goals.

Instructions on how to install `maven` can be found [here](https://maven.apache.org/).

To run the tests:

```bash
  $ mvn test
```

To run the console application:

```bash
  $ mvn package
  $ java -cp target/assignment2*.jar ca.mokhan.comp268.App
```

To generate the javadoc documentation:

```bash
  $ mvn javadoc:javadoc
```

To run a docker version of this assigment:

```bash
$ docker run -it registry.gitlab.com/xlgmokha/comp-268:latest
```

To get shell access to the container and all code:

```bash
$ docker run -it registry.gitlab.com/xlgmokha/comp-268:latest /bin/sh
```

This project attempts to adhere to the project structure guidelines
described in `doc/Comp268_requirements_2017.pdf`. To accomplish this
some customization had to be made to the maven configuration on
`pom.xml`.

The accompanying `Rakefile` includes a `publish` task that takes the
source and bundles a tarball using the project structure guidelines
described in `doc/Comp268_requirements_2017.pdf`.

It is highly suggested to use `mvn` from the root of this source tree
rather than using the bundled package with the non-standard source
layout.

The source code for this project can be found on
`https://gitlab.com/xlgmokha/comp-268`.