Skip to content

Commit bf68b2f

Browse files
author
Reio Opromei
committed
readme run.sh description, scripts info
1 parent 04ea02d commit bf68b2f

File tree

1 file changed

+56
-5
lines changed

1 file changed

+56
-5
lines changed

README.md

+56-5
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,65 @@ Testing Neovim with plugins to create Java project from scratch
33

44
## Shell scripts in repo
55

6-
| Script name | Description |
7-
| ----------- | ----------------------------------------------------- |
8-
| compile.sh | creates class files |
9-
| build.sh | creates class files and builds vimajava.jar from them |
10-
| run.sh | runs created class files directly |
6+
| Script name | Description |
7+
| ----------- | ---------------------------------------------------- |
8+
| compile.sh | creates class files to directory *out/* |
9+
| build.sh | creates class files and builds vimjava.jar from them |
10+
| run.sh | runs created class files from directory *out/* |
11+
12+
Please run the script files in the directory they are located in by default.
13+
14+
15+
## Running class-files
16+
17+
Make sure you have already compiled your class-files.
18+
You can easily compile the project by running *compile.sh* script.
19+
20+
### No arguments given
21+
22+
```
23+
./run.sh
24+
```
25+
returns
26+
```
27+
Tere!
28+
29+
Tervitades
30+
Reio Opromei
31+
```
32+
33+
### 1 argument given
34+
35+
```
36+
./run.sh Kalle
37+
```
38+
returns
39+
```
40+
Tere, Kalle!
41+
42+
Tervitades
43+
Reio Opromei
44+
```
45+
46+
### 2 or more arguments given
47+
48+
```
49+
./run.sh Kalle Kaaviar [maybe some more arguments]
50+
```
51+
returns
52+
```
53+
Tere, Kalle Kaaviar!
54+
55+
Tervitades
56+
Reio Opromei
57+
```
58+
1159

1260
## .jar-archive running
1361

62+
*compile.sh* script auto-generates the class files needed into the *out/* directory.
63+
The archive *vimjava.jar* can be found from the project root.
64+
1465
### No arguments given
1566

1667
```

0 commit comments

Comments
 (0)