summaryrefslogtreecommitdiff
path: root/README.md
blob: 2491ca0ea362b58f99e1c309ab79ce1298695dbe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
Assignment #1

Name: Mo Khan
Student ID: 3431709

This project uses `maven` as the primary build tool. `rake` is used as a
secondary build tool to drive the `mvn` 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/assignment1*.jar ca.mokhan.comp268.App
```

To generate the javadoc documentation:


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

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 `package` task that takes the
source and bundles a zip 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://github.com/mokhan/comp-268`. This is currently a private
repository so a request to the author will need to be made in order to
gain access.

Gitlab was used for hosting the continuous integration builds as shown
in the image below.

![build](doc/gitlab-ci.png)