Skip to content

Commit 121ca9f

Browse files
committed
a bit more detail on the ReadMe
1 parent d699883 commit 121ca9f

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

ReadMe.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ which will build the binaries of the comppiler and put them into the 'dist' dire
3333

3434
The [root kotlin project](https://github.com/JetBrains/kotlin) already has an IDEA project, you can just open it in IDEA.
3535

36-
**Note** though that you need a recent IDEA build (e.g. 11 EAP) which should **not** contain the Kotlin plugin!
36+
**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!
3737

3838
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
3939

@@ -44,7 +44,7 @@ From this root project there are Run/Debug Configurations for running IDEA or th
4444

4545
### Using a pre-built Kotlin IDEA plugin
4646

47-
In a recent IDEA EAP build install the Kotlin plugin:
47+
In a recent [IDEA 11 EAP build](http://confluence.jetbrains.net/display/IDEADEV/IDEA+11.1+EAP) install the Kotlin plugin:
4848

4949
Preferences -> Plugins -> Browse Repositories -> Manage Repositories... -> + to add a new repository URL
5050

@@ -54,6 +54,34 @@ You can now open any Kotlin based projects. Its advisable you don't open the [ro
5454
build the kotlin compiler and plugin itself; instead open the [kotlin libraries project](https://github.com/JetBrains/kotlin/libraries)
5555

5656

57+
## If you want to work on the compiler
58+
59+
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
60+
61+
* download a clean [IDEA 11 EAP build](http://confluence.jetbrains.net/display/IDEADEV/IDEA+11.1+EAP)
62+
* don't install the Kotlin plugin
63+
* open the [root kotlin project](https://github.com/JetBrains/kotlin) in IDEA (opening the kotlin directory)
64+
65+
You can now run the various Run/Debug Configurations such as
66+
67+
* IDEA
68+
* All Compiler Tests
69+
* All IDEA Plugin Tests
70+
71+
72+
## If you want to work on the Kotiln libraries
73+
74+
* download a clean [IDEA 11 EAP build](http://confluence.jetbrains.net/display/IDEADEV/IDEA+11.1+EAP)
75+
* Preferences -> Plugins -> Browse Repositories -> Manage Repositories... -> + to add a new repository URL
76+
* [http://www.jetbrains.com/kotlin/eap-plugin-repository/updatePlugins.xml](http://www.jetbrains.com/kotlin/eap-plugin-repository/updatePlugins.xml)
77+
* open the [kotlin libraries project](https://github.com/JetBrains/kotlin/libraries)
78+
79+
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
80+
81+
cd libraries
82+
mvn -PlocalKotlin
83+
84+
5785
## Kommitter links
5886

5987
* [TeamCity CI build](http://teamcity.jetbrains.com/project.html?projectId=project67&tab=projectOverview)

0 commit comments

Comments
 (0)