Skip to content

Commit b188875

Browse files
committed
Add Makefile simplifying start up instructions
1 parent fbabd84 commit b188875

File tree

5 files changed

+31
-13
lines changed

5 files changed

+31
-13
lines changed

β€Ž.editorconfig

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
9+
[*.java]
10+
indent_size = 4
11+
indent_style = space

β€ŽMakefile

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.PONY: all build test
2+
3+
all: build
4+
5+
build:
6+
@./gradlew assemble --warning-mode all
7+
8+
test:
9+
@./gradlew check --warning-mode all

β€ŽREADME.md

+9-11
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,28 @@
88
[![CodelyTV](https://img.shields.io/badge/codely-tv-green.svg?style=flat-square)](https://codely.tv)
99
[![Workflow Status](https://github.com/CodelyTV/java-basic-skeleton/workflows/Main%20Workflow/badge.svg)](https://github.com/CodelyTV/java-basic-skeleton/actions)
1010

11-
## Introduction
11+
## ℹ️ Introduction
1212

1313
This is a repository intended to serve as a starting point if you want to bootstrap a Java project with JUnit and Gradle.
1414

15-
## How To Start
15+
## 🏁 How To Start
1616

1717
1. Install Java 8: `brew cask install corretto8`
1818
2. Set it as your default JVM: `export JAVA_HOME='/Library/Java/JavaVirtualMachines/amazon-corretto-8.jdk/Contents/Home'`
19-
2. Clone this repository: `git clone https://github.com/CodelyTV/java-basic-skeleton`.
20-
3. Execute some [Gradle lifecycle tasks](https://docs.gradle.org/current/userguide/java_plugin.html#lifecycle_tasks) in order to check everything is OK:
21-
1. Create [the project JAR](https://docs.gradle.org/current/userguide/java_plugin.html#sec:jar) and other project artifacts:
22-
`./gradlew assemble --warning-mode all`
23-
2. Run the tests and plugins verification tasks:
24-
`./gradlew check --warning-mode all`
25-
4. Start developing!
19+
3. Clone this repository: `git clone https://github.com/CodelyTV/java-basic-skeleton`.
20+
4. Execute some [Gradle lifecycle tasks](https://docs.gradle.org/current/userguide/java_plugin.html#lifecycle_tasks) in order to check everything is OK:
21+
1. Create [the project JAR](https://docs.gradle.org/current/userguide/java_plugin.html#sec:jar): `make build`
22+
2. Run the tests and plugins verification tasks: `make test`
23+
5. Start developing!
2624

27-
## How to update dependencies
25+
## ☝️ How to update dependencies
2826

2927
* Gradle (current version: 5.6 - [releases](https://gradle.org/releases/)):
3028
`./gradlew wrapper --gradle-version=5.6 --distribution-type=bin` or modifying the [gradle-wrapper.properties](gradle/wrapper/gradle-wrapper.properties#L3)
3129
* JUnit (current version: 5.5.1 - [releases](https://junit.org/junit5/docs/snapshot/release-notes/index.html)):
3230
[`build.gradle:11`](build.gradle#L11-L12)
3331

34-
## Related repositories
32+
## πŸ’‘ Related repositories
3533

3634
### β˜• Java
3735

β€Žsrc/main/java/tv/codely/java_bootstrap/Greeter.java renamed to β€Žsrc/main/java/tv/codely/java_basic_skeleton/Greeter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package tv.codely.java_bootstrap;
1+
package tv.codely.java_basic_skeleton;
22

33
public class Greeter {
44

β€Žsrc/test/java/tv/codely/java_bootstrap/GreeterShould.java renamed to β€Žsrc/test/java/tv/codely/java_basic_skeleton/GreeterShould.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package tv.codely.java_bootstrap;
1+
package tv.codely.java_basic_skeleton;
22

33
import static org.junit.jupiter.api.Assertions.assertEquals;
44

0 commit comments

Comments
Β (0)