From f42ef45af88ad3f352d21b45ba18bd4b6945bbc5 Mon Sep 17 00:00:00 2001 From: Alexandra Dima Date: Mon, 29 Jul 2019 09:36:35 +0200 Subject: Made corrections to the bsp module readme. --- contrib/bsp/readme.md | 39 +++++++++++++++++++++------------------ 1 file changed, 21 insertions(+), 18 deletions(-) diff --git a/contrib/bsp/readme.md b/contrib/bsp/readme.md index 8e1f38e0..20b627c4 100644 --- a/contrib/bsp/readme.md +++ b/contrib/bsp/readme.md @@ -8,30 +8,33 @@ tasks to be executed from the IDE. # Importing an existing mill project in IntelliJ via BSP -1) Following the mill installation instructions -2) After this contrib module would be published, you should just have to add the -following import statement in the build.sc of your project: +1) Clone the mill git repo +2) Publish your mill version locally with `ci/publish-contrib` +3) Run the following command in the working directory of your project: + + `~/mill-release -i mill.contrib.BSP/install` + + This should create a `.bsp/` directory inside your working directory, + containing a BSP connection file that clients can use to start the + BSP server for Mill. + + This command should be ran whenever you change the version of mill that + you use. + + 4) Now you can use IntelliJ to import your project from existing sources + via bsp ( currently available in the nightly release ). Note: It might + take a few minutes to import a project the very first time. + +After the bsp support module would be published, it should be enough to: + +1) Install mill +2) Add the following import statement in the build.sc of your project: `import $ivy.com.lihaoyi::mill-contrib-bsp:$OFFICIAL_MILL_VERSION` -However, for now, you need to clone the mill repo, publish it locally by running -`ci/publish-local` and importing your local version in build.sc: - - `import $ivy.com.lihaoyi::mill-contrib-bsp:$LOCAL_MILL_VERSION` - 3) Run the following command in the working directory of your project: `mill -i mill.contrib.BSP/install` - This should create a `.bsp/` directory inside your working directory, - containing a BSP connection file that clients can use to start the - BSP server for Mill. - - This command should be ran whenever you chnage the version of mill that - you use. - -4) Now you can use IntelliJ to import your project from existing sources -via bsp ( currently available in the nightly release ). Note: It might -take a few minutes to import a project the very first time. ## Known Issues: -- cgit v1.2.3