From deabd2ffdffa14f134a016b456192cb206d9dd37 Mon Sep 17 00:00:00 2001 From: Nicolas Stucki Date: Mon, 8 May 2017 11:54:04 +0200 Subject: [PATCH] Add documentation on the dotty g8 templates --- README.md | 6 +++++- docs/_includes/getting-started.html | 25 ++++++++++++++++++------- docs/_includes/logo-page.html | 5 +++++ docs/docs/usage/sbt-projects.md | 2 +- docs/index.html | 4 ++-- 5 files changed, 31 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 65f335fbc998..9caf18bb3442 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,13 @@ Dotty * [FAQ](http://dotty.epfl.ch/#why-dotty) * [Mailing list](https://groups.google.com/forum/#!forum/dotty-internals) +Try it out +========== +To try it in your project see also the [Getting Started User Guide](http://dotty.epfl.ch/#getting-started). + How to Contribute ================= -* [Getting Started](http://dotty.epfl.ch/docs/contributing/getting-started.html) +* [Getting Started as Contributor](http://dotty.epfl.ch/docs/contributing/getting-started.html) * [Awesome Error Messages](http://scala-lang.org/blog/2016/10/14/dotty-errors.html) * [Issues](https://github.com/lampepfl/dotty/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) diff --git a/docs/_includes/getting-started.html b/docs/_includes/getting-started.html index c6493d40e9e2..39e9ec2b4fa4 100644 --- a/docs/_includes/getting-started.html +++ b/docs/_includes/getting-started.html @@ -1,9 +1,20 @@ -
-
-

Getting Started

-

- See the example project. -

+
+
+ +

Try Dotty

+

Try it in your browser with Scastie by changing the target to Dotty in the Build Settings.

+ + +

Create a Dotty Project

+

The fastest way to create a new project in Dotty is using sbt (0.13.15+).

+ +

Create a Dotty project:

+ 
sbt new lampepfl/dotty.g8
+ +

Or a Dotty project that cross compiles with Scala 2:

+ 
sbt new lampepfl/dotty-cross.g8
+ +

For documentation see the Dotty Example Project.

+
- diff --git a/docs/_includes/logo-page.html b/docs/_includes/logo-page.html index 3131b6626127..923098ad4de0 100644 --- a/docs/_includes/logo-page.html +++ b/docs/_includes/logo-page.html @@ -1,6 +1,11 @@