diff --git a/getting-started/index.html b/getting-started/index.html index a569246..b0d9d4a 100644 --- a/getting-started/index.html +++ b/getting-started/index.html @@ -40,34 +40,42 @@
- Download the zip file then unzip it in a location we'll call KOBALT_HOME
:
+ If you are on MacOS and have brew
installed:
+
+$ brew install kobalt +$ which kobaltw +/usr/local/bin/brew+ +
+Download the zip file and unzip it in a that you can add to your $PATH
variable:
-cd $KOBALT_HOME +cd yourLocation unzip kobalt-xxx.zip-
- Note: Kobalt doesn't need any environment variable to run, the environment variable used above - is only here for clarity. -
-
- Change to your project directory and call the kobaltw
command with --init
:
-
+Change to your project directory and call the kobaltw
command with --init
:
+
cd ~/java/project -$KOBALT_HOME/kobaltw --init java +kobaltw --init java-
- This command will do two things: -
-kobalt/src/Build.kt
suitable for a brand new Java project.
-kobaltw
) and a few additional files in the kobalt/wrapper
directory. From now on, you can just use ./kobaltw
to build and you can ignore $KOBALT_HOME
.
++This command will do two things: +
+kobalt/src/Build.kt
file based on what was found in your project.kobaltw
) and a few additional files in the kobalt/wrapper
directory.
+From now on, you can just use ./kobaltw
to build and you can ignore the kobaltw
on your path (this command is only useful for initializing projects).
+
You can now attempt to build your project with Kobalt:
@@ -76,6 +84,7 @@ You can now attempt to build your project with Kobalt: If your project follows a regular build structure (e.g. Maven's hierarchy), this should compile your file and create a .jar file. If not, you will have to make a few edits to yourBuild.kt
. As of this writing, Kobalt supports Java and Kotlin projects. +3. Edit kobalt/src/Build.kt
The build file generated by default might need some editing before you can build your project, so take a look at it and adjust whatever is necessary (e.g. package name, version, etc...)