Skip to content

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 3 commits into from
Jun 1, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions docs/docs/contributing/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,5 +65,14 @@ or via bash:
$ dotr
```


Generating Documentation
-------------------------
To generate this page and other static page docs, run
```bash
$ sbt
> genDocs
```

Before contributing to Dotty, we invite you to consult the
[Dotty Developer Guidelines](https://github.com/lampepfl/dotty/blob/master/CONTRIBUTING).
98 changes: 98 additions & 0 deletions docs/docs/usage/getting-started.md
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`.


Option 1: 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`.

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
```
2 changes: 2 additions & 0 deletions docs/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ sidebar:
url: blog/index.html
- title: Usage
subsection:
- title: Getting Started
url: docs/usage/getting-started.html
- title: sbt-projects
url: docs/usage/sbt-projects.html
- title: IDE support for Dotty
Expand Down