Skip to content

Commit 18e3475

Browse files
committed
added requirements and learning sections
1 parent 5439ea0 commit 18e3475

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# FastJ Java Template Program
22

3-
## How to Use
3+
## Requirements
4+
- [Java 16 JDK][jdk-link]
5+
- Basic understanding of Java
6+
7+
8+
## Initial Setup
9+
10+
### Getting this template
411

512
- Clone the repository `git clone https://github.com/lucasstarsz/fastj-java-template`
613
- Or download from https://github.com/lucasstarsz/fastj-java-template/releases/latest
714

8-
_Note: this project uses Java 16 and Gradle 7._
9-
10-
## Running the Program
15+
### Running the Program
1116

1217
1. Build the program:
1318
```bash
@@ -19,7 +24,9 @@ _Note: this project uses Java 16 and Gradle 7._
1924
```
2025

2126

22-
## Distributing Installer/Executable
27+
## General Usage
28+
29+
### Generating Installer/Executable
2330

2431
1. Build the program:
2532
```bash
@@ -34,10 +41,18 @@ _Note: this project uses Java 16 and Gradle 7._
3441
_Having trouble using `gradlew`? Read [this][Terminals Are Different]._
3542

3643

44+
## Learning FastJ
45+
Check out the following:
46+
- [Example Programs][example-programs-readme-link]
47+
- [FastJ Documentation][documentation-link]
48+
49+
3750
## Configuring the Project Variables
3851

3952
Please view the [build.gradle](build.gradle) file -- it contains general instructions for modifying the base example.
4053

4154

55+
[jdk-link]: https://adoptopenjdk.net/?variant=openjdk16 "Java 16 JDK Download"
4256
[Terminals Are Different]: https://gist.github.com/lucasstarsz/9bbc306f8655b916367d557043e498ad "Terminals Access Files Differently"
43-
57+
[example-programs-readme-link]: http://fastj.me/tree/main/src/example "FastJ Examples"
58+
[documentation-link]: https://javadoc.io/doc/io.github.lucasstarsz.fastj/fastj-library "FastJ API Documentation"

0 commit comments

Comments
 (0)