summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexandra Dima <alexandra.dima@jetbrains.com>2019-07-29 09:36:35 +0200
committerSamvel Abrahamyan <samvel1024@gmail.com>2019-10-12 14:33:12 +0200
commitf42ef45af88ad3f352d21b45ba18bd4b6945bbc5 (patch)
tree4984e5bea256f306c659cc4761c9574ba1c5a460
parentdb9f9dab89c37d9a804d7aeb7a01f705a87087ac (diff)
downloadmill-f42ef45af88ad3f352d21b45ba18bd4b6945bbc5.tar.gz
mill-f42ef45af88ad3f352d21b45ba18bd4b6945bbc5.tar.bz2
mill-f42ef45af88ad3f352d21b45ba18bd4b6945bbc5.zip
Made corrections to the bsp module readme.
-rw-r--r--contrib/bsp/readme.md39
1 files 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: