Merge pull request #132 from larsrh/topic/reconstruct-readme

Reconstruct readme branch

Author: milessabin

.gitignore

@@ -59,3 +59,6 @@
 /project/project/target/
 /project/project/project/target/
 /build-sbt/
+
+# Microsite auto-sync Readme file
+/src/main/tut/index.md

README.md

@@ -1,6 +1,4 @@
----
-layout: home
----
+[![Build Status](https://travis-ci.org/typelevel/scala.svg?branch=typelevel-readme)](https://travis-ci.org/typelevel/scala) [![Join the chat at https://gitter.im/typelevel/scala](https://badges.gitter.im/typelevel/scala.svg)](https://gitter.im/typelevel/scala?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 # Typelevel Scala
 

build.sbt

@@ -1,3 +1,5 @@
+import microsites._
+
 name := "Scala"
 version := "1.0"
 scalaVersion := "2.11.8"
@@ -9,7 +11,13 @@ micrositeHomepage := "http://typelevel.org/scala"
 micrositeGithubOwner := "typelevel"
 micrositeGithubRepo := "scala"
 micrositeBaseUrl := "scala"
-micrositeExtraMdFiles := Map(file("README.md") -> "index.md")
+micrositeDocumentationUrl := "docs"
+micrositeExtraMdFiles := Map(
+ file("README.md") -> ExtraMdFileConfig(
+ "index.md",
+ "home"
+ )
+)
 micrositeHighlightTheme := "atom-one-light"
 micrositePalette := Map(
  "brand-primary" -> "#FC4053",

project/plugins.sbt

@@ -1 +1 @@
-addSbtPlugin("com.fortysevendeg" % "sbt-microsites" % "0.2.4")
+addSbtPlugin("com.fortysevendeg" % "sbt-microsites" % "0.4.0")

src/main/resources/microsite/data/menu.yml

@@ -0,0 +1,24 @@
+options:
+ - title: Getting Started
+ url: docs/index.html
+
+ - title: Basic structure
+ url: docs/basic_structure.html
+
+ - title: Project folders
+ url: docs/project_structure.html
+
+ - title: Compiler phases
+ url: docs/phases.html
+
+ - title: Trees
+ url: docs/trees.html
+
+ - title: Symbols
+ url: docs/symbols.html
+
+ - title: Types
+ url: docs/types.html
+
+ - title: References
+ url: docs/references.html

src/main/tut/docs/basic_structure.md

@@ -0,0 +1,15 @@
+---
+layout: docs
+title: Basic structure of the Compiler
+---
+
+Understanding the basic structure
+
+WIP
+
+Want to contribute? [Edit this file](https://github.com/typelevel/scala/edit/typelevel-readme/src/main/resources/microsite/docs/basic_structure.md)
+
+
+
+
+  

src/main/tut/docs/index.md

@@ -0,0 +1,23 @@
+---
+layout: docs
+title: Getting Started
+---
+
+The description part is intended as a guide for programmers seeking to understand the structure,
+and operation of the compiler, and its implementation. Some of its aspects are the following ones:
+
+Some of these contents provide an overview of the compiler code and operation, and the organisation of 
+the project. 
+
+* [Basic structure of the Scala Compiler](./basic_structure.html)
+* [Project folder structure](./project_structure.html)
+* [Compiler phases](./phases.html)
+
+Some contents are specifically dedicated to the key data structures in the compiler that 
+represents elements of the Scala language. 
+
+* [Trees](./trees.html)
+* [Symbols](./symbols.html)
+* [Types](./types.html)
+
+If you want to contribute, you can easily do so via edit links present at the bottom of the pages [like this one](https://github.com/typelevel/scala/edit/typelevel-readme/src/main/resources/microsite/docs/index.md)