From 46d69f9d2cd4b75dbb82ffb1ffda7c7456abc3a3 Mon Sep 17 00:00:00 2001 From: mo khan Date: Mon, 2 Sep 2019 15:41:56 -0600 Subject: update project README --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f6a0768..2b3315c 100644 --- a/README.md +++ b/README.md @@ -28,13 +28,25 @@ To generate the javadoc documentation: $ 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 `package` task that takes the -source and bundles a zip using the project structure guidelines +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 @@ -43,15 +55,3 @@ layout. The source code for this project can be found on `https://gitlab.com/xlgmokha/comp-268`. - -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 -``` -- cgit v1.2.3