James Strachan
104 lines
4.9 KiB
Markdown
104 lines
4.9 KiB
Markdown
# Kotlin Programming Language
|
|
|
|
Welcome to [Kotlin](http://www.jetbrains.com/kotlin)! Some handy links:
|
|
|
|
* [Getting Started Guide](http://confluence.jetbrains.net/display/Kotlin/Getting+Started)
|
|
* [Web Demo](http://kotlin-demo.jetbrains.com/)
|
|
* [Kotlin Site](http://jetbrains.github.com/kotlin/)
|
|
* [API](http://jetbrains.github.com/kotlin/versions/snapshot/apidocs/index.html)
|
|
* [Issue Tracker](http://youtrack.jetbrains.com/issues/KT)
|
|
* [Kotlin Blog](http://blog.jetbrains.com/kotlin/)
|
|
* [follow Kotlin on twitter](http://twitter.com/#!/project_kotlin)
|
|
|
|
## Editing Kotlin
|
|
|
|
* [Kotlin IDEA Plugin](http://hadihariri.com/2012/02/17/the-kotlin-journey-part-i-getting-things-set-up/)
|
|
* [Kotlin TextMate Bundle](https://github.com/k33g/kotlin-textmate-bundle#readme)
|
|
|
|
## Building
|
|
|
|
To build this project, first time you try to build you need to run this:
|
|
|
|
ant -f update_dependencies.xml
|
|
|
|
which will setup the dependencies on
|
|
|
|
* intellij-core: is a part of command line compiler and contains only necessary APIs.
|
|
* idea-full: is a full blown IntelliJ IDEA Community Edition to be used in former plugin module.
|
|
|
|
Then, you need to run
|
|
|
|
ant -f build.xml
|
|
|
|
which will build the binaries of the comppiler and put them into the 'dist' directory.
|
|
|
|
## Working with the project in IDEA
|
|
|
|
The [root kotlin project](https://github.com/JetBrains/kotlin) already has an IDEA project, you can just open it in IDEA.
|
|
|
|
**Note** though that you need a recent IDEA build (e.g. [11 EAP](http://confluence.jetbrains.net/display/IDEADEV/IDEA+11.1+EAP)) which should **not** contain the Kotlin plugin!
|
|
|
|
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 greatest IDEA plugin
|
|
|
|
* VCS -> Git -> Pull
|
|
* Run IDEA
|
|
* a child IDEA with the Kotlin plugin will then startup
|
|
* you can now open the [kotlin libraries project](https://github.com/JetBrains/kotlin/libraries) to then work with the various kotlin libraries etc.
|
|
|
|
### Using a pre-built Kotlin IDEA plugin
|
|
|
|
You can download the latest Kotlin IDEA Plugin from the [IDEA Plugin and Tests CI build](http://teamcity.jetbrains.com/project.html?projectId=project67&tab=projectOverview)
|
|
|
|
Or in a recent [IDEA 11 EAP build](http://confluence.jetbrains.net/display/IDEADEV/IDEA+11.1+EAP) install the Kotlin plugin:
|
|
|
|
Preferences -> Plugins -> Browse Repositories -> Manage Repositories... -> + to add a new repository URL
|
|
|
|
* [http://www.jetbrains.com/kotlin/eap-plugin-repository/updatePlugins.xml](http://www.jetbrains.com/kotlin/eap-plugin-repository/updatePlugins.xml)
|
|
|
|
You can now open any Kotlin based projects. Its advisable you don't open the [root kotlin project](https://github.com/JetBrains/kotlin) as thats intended to be used to
|
|
build the kotlin compiler and plugin itself; instead open the [kotlin libraries project](https://github.com/JetBrains/kotlin/libraries)
|
|
|
|
|
|
## If you want to work on the compiler
|
|
|
|
The Kotlin compiler is currently all written in Java (we plan to port it to Kotlin later). So the easiest way to work on the compiler or IDEA plugin is
|
|
|
|
* download a clean [IDEA 11 EAP build](http://confluence.jetbrains.net/display/IDEADEV/IDEA+11.1+EAP)
|
|
* don't install the Kotlin plugin
|
|
* open the [root kotlin project](https://github.com/JetBrains/kotlin) in IDEA (opening the kotlin directory)
|
|
|
|
You can now run the various Run/Debug Configurations such as
|
|
|
|
* IDEA
|
|
* All Compiler Tests
|
|
* All IDEA Plugin Tests
|
|
|
|
|
|
## If you want to work on the Kotiln libraries
|
|
|
|
* download a clean [IDEA 11 EAP build](http://confluence.jetbrains.net/display/IDEADEV/IDEA+11.1+EAP)
|
|
* Preferences -> Plugins -> Browse Repositories -> Manage Repositories... -> + to add a new repository URL
|
|
* [http://www.jetbrains.com/kotlin/eap-plugin-repository/updatePlugins.xml](http://www.jetbrains.com/kotlin/eap-plugin-repository/updatePlugins.xml)
|
|
* open the [kotlin libraries project](https://github.com/JetBrains/kotlin/libraries)
|
|
|
|
When building the current maven plugin downloads the latest distro of Kotlin. If you want to use your own local build (done via **ant dist**) then try
|
|
|
|
cd libraries
|
|
mvn -PlocalKotlin
|
|
|
|
|
|
## Contributing
|
|
|
|
We love contributions! There's [lots to do](http://youtrack.jetbrains.com/issues/KT) so why not chat
|
|
with us on the [forum](http://devnet.jetbrains.net/community/kotlin?view=discussions) about what you're interested in doing?
|
|
|
|
The best way to contribute is to [fork the project on github](http://help.github.com/fork-a-repo/) then send us a
|
|
[pull request](http://help.github.com/send-pull-requests/) via [github](http://github.com).
|
|
|
|
If you create your own fork, it might help to [enable rebase by default when you pull](http://d.strelau.net/post/47338904/git-pull-rebase-by-default)
|
|
which will avoid your local repo having too many merge commits which will help keep your pull request simple and easy to apply.
|
|
|
|
|
|
## Kommitter links
|
|
|
|
* [TeamCity CI build](http://teamcity.jetbrains.com/project.html?projectId=project67&tab=projectOverview) |