Skip to content

Commit f4fd894

Browse files
committed
update docs
1 parent 41b15a8 commit f4fd894

File tree

3 files changed

+59
-0
lines changed

3 files changed

+59
-0
lines changed

.vscode/extensions.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"recommendations": [
3+
"Oracle.oracle-java",
4+
"vscjava.vscode-java-pack"
5+
]
6+
}

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,48 @@
1+
[![test](https://github.com/ks6088ts-labs/sandbox-java/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/ks6088ts-labs/sandbox-java/actions/workflows/test.yaml?query=branch%3Amain)
2+
[![docker](https://github.com/ks6088ts-labs/sandbox-java/actions/workflows/docker.yaml/badge.svg?branch=main)](https://github.com/ks6088ts-labs/sandbox-java/actions/workflows/docker.yaml?query=branch%3Amain)
3+
[![ghcr-release](https://github.com/ks6088ts-labs/sandbox-java/actions/workflows/ghcr-release.yaml/badge.svg)](https://github.com/ks6088ts-labs/sandbox-java/actions/workflows/ghcr-release.yaml)
4+
15
# sandbox-java
6+
27
A sandbox for Java
8+
9+
## Prerequisites
10+
11+
- [JDK 21+](https://www.oracle.com/java/technologies/downloads/)
12+
- [GNU Make](https://www.gnu.org/software/make/)
13+
14+
## Development instructions
15+
16+
### Local development
17+
18+
Use Makefile to run the project locally.
19+
20+
```shell
21+
# help
22+
make
23+
24+
# install dependencies for development
25+
make install-deps-dev
26+
27+
# run tests
28+
make test
29+
30+
# build applications
31+
make build
32+
33+
# run CI tests
34+
make ci-test
35+
```
36+
37+
### Docker development
38+
39+
```shell
40+
# build docker image
41+
make docker-build
42+
43+
# run docker container
44+
make docker-run
45+
46+
# run CI tests in docker container
47+
make ci-test-docker
48+
```

docs/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# References
2+
3+
- [Java Platform Extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=Oracle.oracle-java)
4+
- [Extension Pack for Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack)
5+
- [Gradle > Installation](https://gradle.org/install/)
6+
- [Gradle > Tutorial](https://docs.gradle.org/current/userguide/part1_gradle_init.html)
7+
- [Could not find or load main class org.gradle.wrapper.GradleWrapperMain](https://stackoverflow.com/a/29806323/4457856)

0 commit comments

Comments
 (0)