Skip to content

Commit 5db18a3

Browse files
committed
add create from template setup option
1 parent 18e3475 commit 5db18a3

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,27 @@
77

88
## Initial Setup
99

10-
### Getting this template
10+
### Download the Template
11+
You have a few options for getting the template:
1112

12-
- Clone the repository `git clone https://github.com/lucasstarsz/fastj-java-template`
13-
- Or download from https://github.com/lucasstarsz/fastj-java-template/releases/latest
13+
#### Create from Template
14+
1. Click the "Use This Template" button at the top of this project. Leave everything on the project creation screen as is, and hit "Create repository from template".
15+
![image](https://user-images.githubusercontent.com/64715411/125542737-6eb23326-d07a-4a28-89af-dcacb4f01cac.png)
16+
![image](https://user-images.githubusercontent.com/64715411/125543010-b960404a-ad40-431c-ab31-c097f52574bb.png)
17+
18+
2. Download your project from GitHub:
19+
- via terminal: `git clone https://github.com/yourgithubusername/yourprojectname`
20+
- or by downloading the ZIP file, specified under the "↓Code" button.
21+
![image](https://user-images.githubusercontent.com/64715411/125545310-c62610da-1eb5-4e80-86b3-352b1ea16612.png)
22+
23+
#### Clone the template directly
24+
1. Clone the repository via terminal: `git clone https://github.com/lucasstarsz/fastj-java-template`
25+
26+
#### Downloading the latest release
27+
Download the archive (.zip file, or tar.gz file) from https://github.com/lucasstarsz/fastj-java-template/releases/latest
1428

15-
### Running the Program
1629

30+
### Running the Program
1731
1. Build the program:
1832
```bash
1933
./gradlew build
@@ -27,7 +41,6 @@
2741
## General Usage
2842

2943
### Generating Installer/Executable
30-
3144
1. Build the program:
3245
```bash
3346
./gradlew build
@@ -42,13 +55,12 @@ _Having trouble using `gradlew`? Read [this][Terminals Are Different]._
4255

4356

4457
## Learning FastJ
45-
Check out the following:
58+
Check out the following links to learn how to use FastJ:
4659
- [Example Programs][example-programs-readme-link]
4760
- [FastJ Documentation][documentation-link]
4861

4962

5063
## Configuring the Project Variables
51-
5264
Please view the [build.gradle](build.gradle) file -- it contains general instructions for modifying the base example.
5365

5466

0 commit comments

Comments
 (0)