From 3dffc1e5d68f8e3ebf14d47e389435e0353fc509 Mon Sep 17 00:00:00 2001 From: Jakub Chrzanowski Date: Sun, 12 Apr 2020 11:36:44 +0200 Subject: [PATCH] readme update --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 23084cb..6cced84 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Hands-On tutorials. ## Usage -Configure the parameters for your hands-on tutorial using a JSON configuration file with the following format +Configure the parameters for your hands-on tutorial using a [JSON configuration file][config] with the following format: ```json { @@ -20,20 +20,25 @@ Configure the parameters for your hands-on tutorial using a JSON configuration f } ``` -It will create all the necessary files for you and all you need to do is to fill in some TODOs and push to GitHub. Of course, you'll -also need to write the contents and projects! +It will create all the necessary files for you and all you need to do is to fill in some TODOs and push to GitHub. +Of course, you'll also need to write the contents and projects! ## Building the project -This is a Kotlin/Native project that targets macOS. To build it, simply run +This is a Kotlin/Native project that targets macOS. To build it, simply run: `gradle macosBinaries` +You'll need to have [XCode][xcode] application installed. + ## Binaries -You can binaries on the [Releases](https://github.com/kotlin-hands-on/hands-on-init/releases) page. +You can find binaries on the [Releases][releases] page. ## License Apache 2.0 +[config]: ./src/macosMain/resources/config.json +[releases]: https://github.com/kotlin-hands-on/hands-on-init/releases +[xcode]: https://apps.apple.com/us/app/xcode/id497799835