Skip to content

Commit 7b282ec

Browse files
authored
Improve setup instructions
1 parent eccecef commit 7b282ec

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

_pages/dev/-contributing/from_source.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@ sidebar:
1717
{% include breadcrumbs.html %}
1818

1919
# Setting the Project Up
20-
If you want to work on the code of libGDX itself, you need to get it set up on your local machine. For this, IntelliJ IDEA/Android Studio is strongly recommended as IDE!
20+
If you want to work on the code of libGDX itself or try out a PR, you need to get the libGDX code base set up on your local machine. If you plan on doing any modifications, we strongly recommend IntelliJ IDEA or Android Studio as IDEs, since they are better suited for working with Gradle and Android.
2121

2222
If you want to submit code back to the project, please also take a moment to review our [guidelines](/dev/contributing/).
23+
{: .notice--info}
2324

2425
1. Fork libGDX to your own Github account.
2526
2. Clone the project to your machine either via your IDE or the command line:
@@ -36,9 +37,9 @@ If you want to submit code back to the project, please also take a moment to rev
3637

3738
Please note that the `fetchNatives` and the `build` tasks [need to be called separately](https://github.com/libgdx/libgdx/pull/7246#issuecomment-1807271546).
3839
{: .notice--warning}
39-
5. Importing the project:
40+
5. If you want to modifiy the code, import it into your favorite IDE:
4041

41-
a) **Via IntelliJ IDEA/Android Studio:**
42+
a) **IntelliJ IDEA/Android Studio:**
4243

4344
- File -> Open -> libGDX root `build.gradle`
4445
- Import all projects
@@ -47,7 +48,7 @@ If you want to submit code back to the project, please also take a moment to rev
4748
- Make sure the Gradle sync succeeds, if not resolve the issues at hand.
4849
- Go into preferences and turn off configure on demand
4950

50-
b) **Via Eclipse:** File -> Import -> Gradle -> Gradle project
51+
b) **Eclipse:** File -> Import -> Gradle -> Gradle project
5152

5253
If you don't want to use Gradle in Eclipse, executing `./gradlew cleanEclipse eclipse` will generate the necessary project files.
5354

@@ -102,11 +103,11 @@ You can install a libGDX snapshot version to your local Maven repository by runn
102103
```
103104
./gradlew publishToMavenLocal
104105
```
105-
This will build and install libGDX and all core components to your local maven repository with the current version declared in the gradle.properties file plus the SNAPSHOT qualifier (in our example `1.12.0.1-SNAPSHOT`).
106+
This will build and install libGDX and all core components to your local maven repository with the current version declared in the gradle.properties file plus the SNAPSHOT qualifier (in our example `1.12.0.1-SNAPSHOT`). To use this version in your project, make sure that its build.gradle file includes `mavenLocal()` in the `repositories` section at the top.
106107

107108
## Publishing a Release version
108109

109-
Publishing properties are defined in the `publish.gradle` file. To install a release version in your local Maven you can override the default repository by creating a file called `override.gradle` in the root folder with the following content
110+
Publishing properties are defined in the `publish.gradle` file. To install a release version (i.e. a version that is not postfixed with `-SNAPSHOT`) in your local Maven, you can override the default repository by creating a file called `override.gradle` in the root folder with the following content
110111
```
111112
configure([
112113
project(":gdx"),

0 commit comments

Comments
 (0)