-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add Getting Started Page for Users #2521
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.
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
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
--- | ||
layout: doc-page | ||
title: Getting Started: Users | ||
--- | ||
|
||
|
||
|
||
Basics | ||
------------ | ||
Make sure that you are using Java 8 or later. The output of `java -version` | ||
should contain `1.8`. | ||
|
||
|
||
Install Dotty | ||
------------- | ||
If you're a Mac user, you can install dotty with [brew](https://brew.sh/) | ||
|
||
```bash | ||
brew install lampepfl/brew/dotty | ||
``` | ||
|
||
If you're a Linux or Windows user, download the [latest release](https://github.com/lampepfl/dotty/releases). Optionally add path of the folder `bin/` to the system environment variable `PATH`. | ||
|
||
Getting Dotty | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. and maybe "Option 2: Using Dotty directly from source" |
||
------------- | ||
```bash | ||
$ git clone --recursive https://github.com/lampepfl/dotty.git | ||
$ cd dotty | ||
$ sbt managedSources # Needed for IDE import to succeed | ||
``` | ||
|
||
Dotty provides a standard sbt build: compiling, running and starting a repl can | ||
all be done from within sbt: | ||
|
||
```bash | ||
$ sbt | ||
> dotc tests/pos/HelloWorld.scala | ||
> dotr HelloWorld | ||
hello world | ||
``` | ||
|
||
Try Dotty | ||
---------- | ||
Try it in your browser with [Scastie](https://scastie.scala-lang.org/?target=dotty) | ||
|
||
|
||
Create a Dotty Project | ||
----------------------- | ||
The fastest way to create a new project in dotty is using [sbt (0.13.5+)](http://www.scala-sbt.org/) | ||
|
||
Create a dotty project: | ||
```bash | ||
$ sbt new lampepfl/dotty.g8 | ||
``` | ||
|
||
Or a Dotty project that cross compiles with Scala 2: | ||
```bash | ||
$ sbt new lampepfl/dotty-cross.g8 | ||
``` | ||
|
||
For an example project, see the [Dotty Example Proejct](https://github.com/lampepfl/dotty-example-project) | ||
|
||
|
||
Bash Scripts | ||
------------- | ||
Assuming that you have cloned the Dotty repo locally, append the following line on your `.bash_profile`: | ||
|
||
```shell | ||
$ export PATH=$HOME/dotty/bin:$PATH | ||
``` | ||
|
||
and you will be able to run the corresponding commands directly from your console: | ||
|
||
```shell | ||
# Compile code using Dotty | ||
$ dotc tests/pos/HelloWorld.scala | ||
|
||
# Run it with the proper classpath | ||
$ dotr HelloWorld | ||
``` | ||
|
||
|
||
Starting a REPL | ||
---------------- | ||
```bash | ||
$ sbt | ||
> repl | ||
Welcome to Scala.next (pre-alpha) (Java HotSpot(TM) 64-Bit Server VM, Java 1.8.0_101). | ||
Type in expressions to have them evaluated. | ||
Type :help for more information. | ||
scala> | ||
``` | ||
|
||
or via bash: | ||
|
||
```bash | ||
$ dotr | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you make it "Option 1: Install Dotty"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, will do :)