diff --git a/ReadMe.md b/ReadMe.md index 7148172858f..66718ed3776 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -9,16 +9,18 @@ Welcome to [Kotlin](http://kotlinlang.org/)! Some handy links: * [Kotlin Site](http://kotlinlang.org/) * [Getting Started Guide](http://kotlinlang.org/docs/tutorials/getting-started.html) * [Try Kotlin](http://try.kotlinlang.org/) - * [API](http://jetbrains.github.com/kotlin/versions/snapshot/apidocs/index.html) + * [Kotlin Standard Library](http://kotlinlang.org/api/latest/jvm/stdlib/index.html) * [Issue Tracker](http://youtrack.jetbrains.com/issues/KT) * [Forum](http://devnet.jetbrains.net/community/kotlin?view=discussions) * [Kotlin Blog](http://blog.jetbrains.com/kotlin/) * [Follow Kotlin on Twitter](https://twitter.com/kotlin) + * [Public Slack channel](http://kotlinslackin.herokuapp.com/) * [TeamCity CI build](https://teamcity.jetbrains.com/project.html?tab=projectOverview&projectId=Kotlin) ## Editing Kotlin * [Kotlin IntelliJ IDEA Plugin](http://hadihariri.com/2012/02/17/the-kotlin-journey-part-i-getting-things-set-up/) + * [Kotlin Eclipse Plugin](http://kotlinlang.org/docs/tutorials/getting-started-eclipse.html) * [Kotlin TextMate Bundle](https://github.com/k33g/kotlin-textmate-bundle#readme) ## Building @@ -60,7 +62,7 @@ To keep the plugin version in sync with the rest of the team and our [Continuous you should install the according to the [instructions below](#plugin-for-contributors). If you want to have an IntelliJ IDEA installation without the Kotlin plugin which is separate to your default IntelliJ IDEA installation which has the Kotlin -plugin [see this document](http://devnet.jetbrains.net/docs/DOC-181) which describes how to have mutliple IntelliJ IDEA installations using different configurations and plugin directories. +plugin [see this document](http://devnet.jetbrains.net/docs/DOC-181) which describes how to have multiple IntelliJ IDEA installations using different configurations and plugin directories. From this root project there are Run/Debug Configurations for running IDEA or the Compiler Tests for example; so if you want to try out the latest and greatest IDEA plugin @@ -99,15 +101,22 @@ Then update the list of plugins in "Browse Repositories", you'll see two version # Contributing -We love contributions! There's [lots to do on Kotlin](http://youtrack.jetbrains.com/issues/KT) and on the [standard library](https://youtrack.jetbrains.com/issues/KT?q=Subtask+of%3A+KT-2554+%23Unresolved) so why not chat with us on the [forum](http://devnet.jetbrains.net/community/kotlin?view=discussions) about what you're interested in doing? +We love contributions! There's [lots to do on Kotlin](http://youtrack.jetbrains.com/issues/KT) and on the +[standard library](https://youtrack.jetbrains.com/issues/KT?q=Subtask+of%3A+KT-2554+%23Unresolved) so why not chat with us +about what you're interested in doing? Please join the #kontributors channel in [our Slack chat](http://kotlinslackin.herokuapp.com/) +and let us know about your plans. If you want to find some issues to start off with, try [this query](https://youtrack.jetbrains.com/issues?q=tag%3A+%7BUp+For+Grabs%7D+%23Unresolved) which should find all issues that marked as "up-for-grabs". Currently only committers can assign issues to themselves so just add a comment if you're starting work on it. -A nice gentle way to contribute would be to review the [API docs](http://jetbrains.github.com/kotlin/versions/snapshot/apidocs/index.html) and find classes or functions which are not documented very well and submit a patch. +A nice gentle way to contribute would be to review the [standard library docs](http://kotlinlang.org/api/latest/jvm/stdlib/index.html) +and find classes or functions which are not documented very well and submit a patch. -In particular it'd be great if all functions included a nice example of how to use it such as for the filter() function on Collection. This is implemented using the @includeFunctionBody macro to include code from a test function. This serves as a double win; the API gets better documented with nice examples to help new users and the code gets more test coverage. +In particular it'd be great if all functions included a nice example of how to use it such as for the +hashMapOf() function. +This is implemented using the @sample +macro to include code from a test function. This serves as a double win; the API gets better documented with nice examples to help new users and the code gets more test coverage. Also the [JavaScript translation](https://github.com/JetBrains/kotlin/blob/master/js/ReadMe.md) could really use your help. See the [JavaScript contribution section](https://github.com/JetBrains/kotlin/blob/master/js/ReadMe.md) for more details.