updated the readme to try help folks get started working on the project

This commit is contained in:
James Strachan
2012-03-13 09:04:07 +00:00
parent 5189c6519c
commit e5eaffc1c8
+27 -2
View File
@@ -14,7 +14,7 @@ Welcome to [Kotlin](http://www.jetbrains.com/kotlin)! Some handy links:
## Building
To build this project you need to run
To build this project, first time you try to build you need to run this:
ant -f update_dependencies.xml
@@ -27,7 +27,32 @@ Then, you need to run
ant -f build.xml
which will build the binaries and put them into the 'dist' directory.
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) 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
In a recent IDEA EAP build 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)
## Kommitter links