starred/pkl
1
0
Fork 0
mirror of https://github.com/apple/pkl.git synced 2026-04-24 09:18:35 +02:00
Code Issues 198 Packages Projects Releases 10 Wiki Activity

Update development instructions

Browse Source 
- remove "Setup Gradle on your system" (too vague and doesn't seem necessary)
- remove "gw pkldoc" (obsolete)
- improve docs for common build commands
This commit is contained in:
translatenix
2024-02-12 07:09:27 -08:00
committed by Philip K.F. Hölzenspies
parent 6f915e5b90
commit a28ef85698
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
DEVELOPMENT.adoc
View File

@@ -7,7 +7,6 @@
== Setup == Setup
. (mandatory) Install {uri-jdk}[OpenJDK 11 HotSpot] (as long as we support JDK11) . (mandatory) Install {uri-jdk}[OpenJDK 11 HotSpot] (as long as we support JDK11)
. (mandatory) Setup Gradle on your system
. (recommended) Install {uri-intellij}[IntelliJ IDEA 2023.x] + . (recommended) Install {uri-intellij}[IntelliJ IDEA 2023.x] +
To import the project into IntelliJ, go to File->Open and select the project's root directory. To import the project into IntelliJ, go to File->Open and select the project's root directory.
If the project is opened but not imported, look for a popup in the lower right corner If the project is opened but not imported, look for a popup in the lower right corner
@@ -30,13 +29,16 @@ jenv enable-plugin export
---- ----
gw clean gw clean
gw test gw test
gw spotlessApply # fix code formatting
gw build # build everything except native executables gw build # build everything except native executables
gw buildNative # build macOS executable on macOS, gw buildNative # build macOS executable on macOS,
# Linux and Alpine executables on Linux # Linux and Alpine executables on Linux
gw pkldoc # generate standard library docs # (Alpine executable is only built if ~/staticdeps/bin/musl-gcc exists)
pkl-cli/build/executable/jpkl # run Java executable pkl-cli/build/executable/jpkl # run Java executable
pkl-cli/build/executable/pkl-macos-amd64 # run Mac executable pkl-cli/build/executable/pkl-macos-amd64 # run Mac executable
pkl-cli/build/executable/pkl-linux-amd64 # run Linux executable
pkl-cli/build/executable/pkl-alpine-linux-amd64 # run Alpine Linux executable
---- ----
== Update Gradle == Update Gradle