Skip to content

Update the Getting Started page(s) for the latest cs behavior. #2328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 14, 2022
Merged

Update the Getting Started page(s) for the latest cs behavior. #2328

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions _includes/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,24 @@ Along with managing JVMs, `cs setup` also installs useful command-line tools:
- The [sbt](https://www.scala-sbt.org/) build tool
- [Ammonite](https://ammonite.io/), an enhanced REPL
- [scalafmt](https://scalameta.org/scalafmt/), the Scala code formatter
- `scalac` (the Scala 2 compiler)
- `scala` (the Scala 2 REPL and script runner).
- `scalac` (the Scala compiler)
- `scala` (the Scala REPL and script runner).

For more information about `cs`, read
[coursier-cli documentation](https://get-coursier.io/docs/cli-overview).

> Currently, `cs setup` installs the Scala 2 compiler and runner (the `scalac` and
> `scala` commands, respectively). This is usually not an issue because most projects
> use a build tool that works with both Scala 2 and Scala 3.
> Nevertheless, you can install the Scala 3 compiler and runner as command-line tools
> by running the following additional commands:
> `cs setup` installs the Scala 3 compiler and runner by default (the `scalac` and
> `scala` commands, respectively). Whether you intend to use Scala 2 or 3,
> this is usually not an issue because most projects use a build tool that will
> use the correct version of Scala irrespective of the one installed "globally".
> Nevertheless, you can always launch a specific version of Scala using
> ```
> $ cs install scala3-compiler
> $ cs install scala3
> $ cs launch scala:{{ site.scala-version }}
> $ cs launch scalac:{{ site.scala-version }}
> ```
> If you prefer Scala 2 to be run by default, you can force that version to be installed with:
> ```
> $ cs install scala:{{ site.scala-version }} scalac:{{ site.scala-version }}
> ```

### ...or manually
Expand Down Expand Up @@ -164,7 +168,7 @@ There are a multitude of mailing lists and real-time chat rooms in case you want

<!-- Hidden elements whose content are used to provide OS-specific download instructions.
-- This is handled in `resources/js/functions.js`.
-->
-->
<div style="display:none" id="stepOne-linux">
<code class="hljs">$ curl -fLo cs https://git.io/coursier-cli-linux && chmod +x cs && ./cs setup </code> <br>
</div>
Expand Down