Skip to content

Add documentation on the dotty g8 templates #2389

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 1 commit into from
May 8, 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
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
25 changes: 18 additions & 7 deletions docs/_includes/getting-started.html
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
<div class="page white">
<div class="centered" style="padding-top: 32px">
<h1 id="getting-started">Getting Started</h1>
<p>
See the <a href="https://github.com/lampepfl/dotty-example-project">example project</a>.
</p>
<div class="page blue">
<div class="centered questions">

<h1 id="getting-started">Try Dotty</h1>
<p>Try it in your browser with <a href="https://scastie.scala-lang.org/">Scastie</a> by changing the target to Dotty in the Build Settings.</p>


<h1 id="getting-started-with-a-project">Create a Dotty Project</h1>
<p>The fastest way to create a new project in Dotty is using <a href="http://www.scala-sbt.org/">sbt (0.13.15+)</a>.</p>

<p>Create a Dotty project:</p>
<pre class="sourceCode bright"><code>sbt new <a href="https://github.com/lampepfl/dotty.g8">lampepfl/dotty.g8</a></code></pre>

<p>Or a Dotty project that cross compiles with Scala 2:</p>
<pre class="sourceCode bright"><code>sbt new <a href="https://github.com/lampepfl/dotty-cross.g8">lampepfl/dotty-cross.g8</a></code></pre>

<p>For documentation see the <a href="https://github.com/lampepfl/dotty-example-project">Dotty Example Project</a>.</p>

</div>
</div>

5 changes: 5 additions & 0 deletions docs/_includes/logo-page.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
<div class="page red exactly-one-page">
<div id="header">
<nav class="nav nav-pills">
<li class="nav-item">
<a class="nav-link" href="#getting-started">
Try it now
</a>
</li>
<li class="nav-item">
<a class="nav-link" href="#why-dotty">
FAQ
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/usage/sbt-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ layout: doc-page
title: "Using Dotty with sbt"
---

See the [example project](https://github.com/lampepfl/dotty-example-project).
To try it in your project see the [Getting Started User Guide](http://dotty.epfl.ch/#getting-started).
4 changes: 2 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
---
<div id="content">
{% include logo-page.html %}
{% include faq.html %}
{% include features.html %}
{% include getting-started.html %}
{% include features.html %}
{% include faq.html %}
</div>