Add Makefile simplifying start up instructions

JavierCane · JavierCane · commit b188875f0636 · 2019-08-20T12:10:51.000+02:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,11 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.java]
+indent_size = 4
+indent_style = space
diff --git a/Makefile b/Makefile
@@ -0,0 +1,9 @@
+.PONY: all build test
+
+all: build
+
+build:
+	@./gradlew assemble --warning-mode all
+
+test:
+	@./gradlew check --warning-mode all
diff --git a/README.md b/README.md
@@ -8,30 +8,28 @@
 [![CodelyTV](https://img.shields.io/badge/codely-tv-green.svg?style=flat-square)](https://codely.tv)
 [![Workflow Status](https://github.com/CodelyTV/java-basic-skeleton/workflows/Main%20Workflow/badge.svg)](https://github.com/CodelyTV/java-basic-skeleton/actions)
 
-## Introduction
+## ℹ️ Introduction
 
 This is a repository intended to serve as a starting point if you want to bootstrap a Java project with JUnit and Gradle.
 
-## How To Start
+## 🏁 How To Start
 
 1. Install Java 8: `brew cask install corretto8`
 2. Set it as your default JVM: `export JAVA_HOME='/Library/Java/JavaVirtualMachines/amazon-corretto-8.jdk/Contents/Home'`
-2. Clone this repository: `git clone https://github.com/CodelyTV/java-basic-skeleton`.
-3. Execute some [Gradle lifecycle tasks](https://docs.gradle.org/current/userguide/java_plugin.html#lifecycle_tasks) in order to check everything is OK:
-    1. Create [the project JAR](https://docs.gradle.org/current/userguide/java_plugin.html#sec:jar) and other project artifacts:
-    `./gradlew assemble --warning-mode all`
-    2. Run the tests and plugins verification tasks:
-    `./gradlew check --warning-mode all`
-4. Start developing!
+3. Clone this repository: `git clone https://github.com/CodelyTV/java-basic-skeleton`.
+4. Execute some [Gradle lifecycle tasks](https://docs.gradle.org/current/userguide/java_plugin.html#lifecycle_tasks) in order to check everything is OK:
+    1. Create [the project JAR](https://docs.gradle.org/current/userguide/java_plugin.html#sec:jar): `make build`
+    2. Run the tests and plugins verification tasks: `make test`
+5. Start developing!
 
-## How to update dependencies
+## ☝️ How to update dependencies
 
 * Gradle (current version: 5.6 - [releases](https://gradle.org/releases/)):
 `./gradlew wrapper --gradle-version=5.6 --distribution-type=bin` or modifying the [gradle-wrapper.properties](gradle/wrapper/gradle-wrapper.properties#L3)
 * JUnit (current version: 5.5.1 - [releases](https://junit.org/junit5/docs/snapshot/release-notes/index.html)):
 [`build.gradle:11`](build.gradle#L11-L12)
 
-## Related repositories
+## 💡 Related repositories
 
 ### ☕ Java
 
diff --git a/src/main/java/tv/codely/java_basic_skeleton/Greeter.java b/src/main/java/tv/codely/java_basic_skeleton/Greeter.java
@@ -1,4 +1,4 @@
-package tv.codely.java_bootstrap;
+package tv.codely.java_basic_skeleton;
 
 public class Greeter {
 
diff --git a/src/test/java/tv/codely/java_basic_skeleton/GreeterShould.java b/src/test/java/tv/codely/java_basic_skeleton/GreeterShould.java
@@ -1,4 +1,4 @@
-package tv.codely.java_bootstrap;
+package tv.codely.java_basic_skeleton;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package tv.codely.java_bootstrap;`
	`1`	`+package tv.codely.java_basic_skeleton;`
`2`	`2`
`3`	`3`	`public class Greeter {`
`4`	`4`