Skip to content

Commit 024ad5e

Browse files
feat: Added README
1 parent 856f06c commit 024ad5e

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
# Agones Java Client SDK
3+
4+
**Third-party Agones Java Client SDK supporting all stable features and beta counters**
5+
6+
- For [Agones](https://agones.dev)
7+
8+
## Development
9+
10+
Full development setup available as [Development Container](https://containers.dev/).
11+
Please use it for being able to tell "It works on my machine".
12+
13+
**Docker is required to be installed on your machine!**
14+
15+
### IntelliJ IDEA
16+
17+
- Open IntelliJ (Welcome screen)
18+
- Navigate to `Remote Development` - `Dev Containers`
19+
- Press `New Dev Container`
20+
- Select `From VCS Project`
21+
- Select and connect with `Docker`
22+
- Select `IntelliJ IDEA`
23+
- Enter `Git Repository`: `https://github.com/o7studios/agones-java-sdk`
24+
- Select `Detection for devcontainer.json file` `Automatic`
25+
- Press `Build Container and Continue`
26+
27+
### Development Container Issues
28+
29+
If you encounter an issue with setting up a development container, please
30+
try to rebuild it first before opening a GitHub Issue. It's not uncommon
31+
that some issues may fix themselves after a fresh container rebuild.

0 commit comments

Comments
 (0)