Improve the getting started page #1675
Conversation
_getting-started/index.md
Outdated
| You can [try Scala in your browser](https://scastie.scala-lang.org/MHc7C9iiTbGfeSAvg8CKAA), with access to all Scala compilers and | ||
| all published libraries. | ||
|
|
||
| ## Installing Scala |
There was a problem hiding this comment.
| ## Installing Scala | |
| ## Install Scala |
There was a problem hiding this comment.
And then, I would add a sentence explaining what that means to “install” Scala (ie, installing various command-line tools such as the Scala compiler and build tools), and that we are going to explain two ways of doing it: using the cs tool that automatically installs all the requirements, or by manually installing each thing.
_getting-started/index.md
Outdated
|
|
||
|
|
||
| Along with managing JVMs, it also installs useful command line tools: | ||
| ammonite, coursier, scala, scalac, sbt-launcher, scalafmt. |
There was a problem hiding this comment.
| ammonite, coursier, scala, scalac, sbt-launcher, scalafmt. | |
| [amm](https://ammonite.io/), [coursier](https://get-coursier.io/), scala, scalac (the Scala compiler), [sbt](https://www.scala-sbt.org/), [scalafmt](https://scalameta.org/scalafmt/). |
BTW, @alexarchambault, is it useful to install the coursier CLI if we already have installed cs?
There was a problem hiding this comment.
This is also discussed here: scala/scala-lang#1130 (comment)
After running cs setup for the first time, cs installs itself right? Should we recommend to delete the download?
We can, yes, and maybe should actually.
There was a problem hiding this comment.
BTW, @alexarchambault, is it useful to install the coursier CLI if we already have installed cs?
It depends how you got cs. If you downloaded it manually, let it install cs itself in the installation directory, and remove the one you downloaded yourself.
_getting-started/index.md
Outdated
| More documentation about sbt can be found in the [Scala Book](/overviews/scala-book/scala-build-tool-sbt.html) | ||
| or in the official sbt [documentation](https://www.scala-sbt.org/1.x/docs/index.html) | ||
|
|
||
| ### Without using the command line |
There was a problem hiding this comment.
| ### Without using the command line | |
| ### With an IDE |
?
|
@julienrf, @Philippus can you please review the new patch? Thanks |
There was a problem hiding this comment.
Thank you @mlachkar! I think the structure of the getting started page is greatly improved with your changes. I’m not sure about the english-style in some parts, though. @SethTisue, would you be interested in proof-reading?
|
I apologize for neglecting this. How does this relate to scala/scala-lang#1162 ...? If this PR is still considered active, lmk and I promise to review it for English style. |
|
I didn't notice this was open! I'm closing scala/scala-lang#1162 for now, we can re-open if needed. |
|
If we are going to be recommending the usage of coursier, the content of this PR is still accurate and I would love to have reviews again (@SethTisue). |
* making the page self contained: users can have a working "hello-world" without visiting other pages * introducing couriser-cli a recommended way to install jvm requirements * adding Vscode/metals as a possible IDE * advertising only two ways of starting with Scala: interactive with Scastie or with and IDE + sbt
Co-Authored-By: Philippus Baalman <philippus@gmail.com>
Co-Authored-By: Philippus Baalman <philippus@gmail.com>
Co-Authored-By: Philippus Baalman <philippus@gmail.com>
Co-Authored-By: Philippus Baalman <philippus@gmail.com>
Co-Authored-By: Philippus Baalman <philippus@gmail.com>
Co-Authored-By: Philippus Baalman <philippus@gmail.com>
mlachkar
force-pushed
the
getting-started-page
branch
from
0433764 to
9865a70
Compare
without visiting other pages