Permalink
Browse files

update the quick start install docs

  • Loading branch information...
willingc committed Jan 23, 2019
1 parent 2ff4799 commit ed35a8fb1725155d7a4646453bd2c71af196950f
Showing with 28 additions and 8 deletions.
  1. +28 −8 docs/pages/quick-start-install.md
@@ -2,25 +2,45 @@
title: Installation
---

Create a launcher via [coursier](http://get-coursier.io) with
## Create a launcher

1. Set the desired version of Scala and Almond as environment variables:

```bash
$ SCALA_VERSION=@SCALA_VERSION@ ALMOND_VERSION=@VERSION@
```

The available versions of Scala and Almond are can be found [here](https://github.com/almond.sh/almond/releases).
Adjust `ALMOND_VERSION` and `SCALA_VERSION` at your convenience to meet your
needs. Not all combinations are guaranteed to be available. See the available
combinations [here](install-versions.md)).

2. Create a launcher via [coursier](http://get-coursier.io):

```bash
$ coursier bootstrap @EXTRA_COURSIER_ARGS@\
-r jitpack \
-i user -I user:sh.almond:scala-kernel-api_$SCALA_VERSION:$ALMOND_VERSION \
sh.almond:scala-kernel_$SCALA_VERSION:$ALMOND_VERSION \
--sources --default=true \
-o almond
```

See the available versions of almond [here](https://github.com/jupyter-scala/jupyter-scala/releases),
adjust `ALMOND_VERSION` and `SCALA_VERSION` at your convenience (not all combinations are guaranteed
to be available, see the available combinations [here](install-versions.md)).
## Install the almond kernel

3. Run the launcher to install the almond kernel:

Run the launcher like
```bash
$ ./almond --install
```
to install the kernel. See `./almond --help` for the available options. Once the kernel is
installed, the generated launcher can then be safely removed, with `rm -f almond`.

4. Once the kernel is installed, you can use it within Jupyter or nteract.

If you are satisfied that the kernel is working properly, you may safely
remove the almond launcher: `rm -f almond`

## Getting help about the launcher

- Help: `./almond --help`
- Available options:

Once the kernel is installed, the generated launcher can then be safely removed, with `rm -f almond`.

0 comments on commit ed35a8f

Please sign in to comment.