Skip to content

Commit 2a253d6

Browse files
authored
Update README.md to give IDE instructions
1 parent 51bac18 commit 2a253d6

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,49 @@ String text = OSISUtil.getCanonicalText(data.getOsisFragment());
7878
System.out.println(text);
7979
```
8080

81+
---
82+
## Opening JSword in Popular IDEs
83+
84+
JSword uses **Gradle** as its build tool. This makes it easy to open and build the project in all modern Java IDEs.
85+
Follow the instructions below for your preferred environment:
86+
87+
### Eclipse
88+
89+
1. Open Eclipse.
90+
2. Select **File > Import... > Gradle > Existing Gradle Project**.
91+
3. Navigate to the JSword directory and follow the prompts.
92+
4. Eclipse will automatically configure the project using the `build.gradle` file.
93+
94+
### IntelliJ IDEA
95+
96+
1. Open IntelliJ IDEA.
97+
2. Select **File > Open...** and choose the JSword project directory.
98+
3. IntelliJ will detect the `build.gradle` file and prompt you to import the Gradle project.
99+
4. Accept the defaults and complete the import.
100+
101+
### Visual Studio Code
102+
103+
1. Open Visual Studio Code.
104+
2. Install the **Java Extension Pack** (if not already installed).
105+
3. Use **File > Open Folder...** to open the JSword project directory.
106+
4. VS Code will recognize the Gradle build and provide Java project features.
107+
108+
---
109+
110+
**Note:**
111+
There is no need to generate or commit IDE-specific files (such as `.project`, `.classpath`, `.settings/`, `.idea/`, or `.vscode/`). All required project structure and dependencies are managed by Gradle.
112+
113+
For command-line builds, use:
114+
115+
```sh
116+
./gradlew build
117+
```
118+
119+
or on Windows:
120+
121+
```sh
122+
gradlew.bat build
123+
```
81124
---
82125

83126
## Contributing

0 commit comments

Comments
 (0)