Skip to content

readme update #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

readme update #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -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