Skip to content

Commit

Permalink
Change universal docs to coursier docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jvican committed May 11, 2020
1 parent 3534766 commit bcff507
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 24 deletions.
41 changes: 21 additions & 20 deletions docs/tools/universal/install.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,31 @@

```sh
curl -L https://github.com/scalacenter/bloop/releases/download/v@VERSION@/install.py | python
```

Bloop installs under the standard `$HOME/.bloop` directory.

### Requirements

1. **Java 8 or higher**
1. **Python 2 or 3** (installation script and CLI client are written in Python)
- **Java 8 or higher**
- Coursier >= `2.0.0-RC6-13`

### Installation options

<blockquote>
<p>
Skip this sub-section if you're not interested in customizing the installation.
</p>
</blockquote>
```sh
coursier install bloop --only-prebuilt=true
```

Coursier will install bloop in its installation directory. When installing, you
might get a log similar to this:

```
usage: install.py [-h] [-d DEST] -v VERSION -n NAILGUN -c COURSIER
[--ivy-home IVY_HOME] [--bloop-home BLOOP_HOME]
➜ ~ ➜ ~ coursier install bloop
https://repo1.maven.org/maven2/io/get-coursier/apps/maven-metadata.xml
100.0% [##########] 993 B (20.2 KiB / s)
https://repo1.maven.org/maven2/io/get-coursier/apps/maven-metadata.xml
No new update since 2020-05-11 10:44:44
https://repo1.maven.org/maven2/io/get-coursier/apps/0.0.23/apps-0.0.23.pom
100.0% [##########] 1.3 KiB (12.9 KiB / s)
https://repo1.maven.org/maven2/org/scala-lang/scala-library/maven-metadata.xml
No new update since 2020-04-23 06:26:04
Wrote bloop
Warning: /Users/jvicentecantero/Library/Application Support/Coursier/bin is not in your PATH
To fix that, add the following line to ~/.zshrc
```

The installation scripts places the bloop installation in `$HOME/.bloop` by default.
If you want to change the location to, say, `/opt/bloop`, then:

1. Use `--dest /opt/bloop`; and,
2. Add `/opt/bloop` to your `$PATH` in all your live terminals.
Make sure you add the `Coursier` binary directory to your `$PATH`.
8 changes: 4 additions & 4 deletions project/ReleaseUtils.scala
Original file line number Diff line number Diff line change
Expand Up @@ -104,13 +104,13 @@ object ReleaseUtils {
def remote(name: String, tagName: String, sha: String, label: String): Artifact = {
val url = {
if (label == "coursier-channel")
s"https://github.com/scalacenter/bloop/releases/download/$tagName/$name.json"
s"https://github.com/scalacenter/bloop/releases/download/$tagName/$name"
else if (label == "bash-completions")
s"https://raw.githubusercontent.com/scalacenter/bloop/releases/download/$tagName/bash-completions"
s"https://github.com/scalacenter/bloop/releases/download/$tagName/bash-completions"
else if (label == "zsh-completions")
s"https://raw.githubusercontent.com/scalacenter/bloop/releases/download/$tagName/zsh-completions"
s"https://github.com/scalacenter/bloop/releases/download$tagName/zsh-completions"
else if (label == "fish-completions")
s"https://raw.githubusercontent.com/scalacenter/bloop/releases/download/$tagName/fish-completions"
s"https://github.com/scalacenter/bloop/releases/download/$tagName/fish-completions"
else sys.error("Unrecognized label for artifact, can't create remote artifact!")
}

Expand Down

0 comments on commit bcff507

Please sign in to comment.