java-fundamentals project - the "how-to-use" instruction

Requirements

For working with project you should have installed on you machine:

1. Make (for installation instructions - see below)
2. Maven (for installation instructions - see below)
3. JEnv - for *nix/Mac only!
4. XMLStarlet Toolkit
5. XsltProc

For Windows users:

In Makefile:

• Comment or delete the JEnv block in "init" task
• Delete "./" substring in some commands, like ./mvnw verify - it should looks like "mvnw verify"
• Replace "ln" with "mklink" command (see https://stackoverflow.com/questions/17246558/what-is-the-windows-equivalent-to-the-ln-s-target-folder-link-folder-unix-s)

How to install project

in {project.basedir} run

$ make init

How use as a library (in maven)

Step 1

Add the JitPack repository to your build file

<repositories>
  <repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
  </repository>
</repositories>

Step 2

Add the dependency

<dependency>
  <groupId>com.github.Vyacheslav-Lapin</groupId>
  <artifactId>java-fundamentals-epam</artifactId>
  <version>MASTER</version>
</dependency>

How to install Make

Before install, you may need to check if it's already installed

How to check if installed

For check, please write in terminal:

$ make -v

output should looks like this:

GNU Make 4.2.1
Built for x86_64-apple-darwin18.2.0
Copyright (C) 1988-2016 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

Install

On Mac

$ brew install make

On Debian Linux

$ apt install make

On Windows

$ cinst make

How to install Maven

Before install, you may need to check if it''s already installed

How to check if installed

For check, please write in terminal:

$ mvn -v

output should looks like this:

Apache Maven 3.6.2 (40f52333136460af0dc0d7232c0dc0bcf0d9e117; 2019-08-27T18:06:16+03:00)
Maven home: /usr/local/Cellar/maven/3.6.2/libexec
Java version: 12.0.2, vendor: Oracle Corporation, runtime: /Library/Java/JavaVirtualMachines/openjdk-12.0.2.jdk/Contents/Home
Default locale: en_GB, platform encoding: UTF-8
OS name: "mac os x", version: "10.14.6", arch: "x86_64", family: "mac"

Install

On Mac

$ brew install maven

On Debian Linux

$ apt install mvn

On Windows

$ cinst mvn