diff --git a/README.md b/README.md index d28db81075..df4f87aa8c 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ # Scala Documentation # -This repository contains the source for the Scala documentation website, as well as the source for "Scala Improvement Process" (SIP) documents. +This repository contains the source for the Scala documentation website, as well as the source for "Scala Improvement Process" (SIP) documents. ## Contributing ## -Please have a look at [http://docs.scala-lang.org/contribute.html](http://docs.scala-lang.org/contribute.html) before making a contribution. +Please have a look at [http://docs.scala-lang.org/contribute.html](http://docs.scala-lang.org/contribute.html) before making a contribution. This document gives an overview of the type of documentation contained within the Scala Documentation repository and the repository's structure. -Small changes, or corrected typos will generally be pulled in right away. Large changes, like the addition of new documents, or the rewriting of -existing documents will be thoroughly reviewed-- please keep in mind that, generally, new documents must be very well-polished, complete, and maintained +Small changes, or corrected typos will generally be pulled in right away. Large changes, like the addition of new documents, or the rewriting of +existing documents will be thoroughly reviewed-- please keep in mind that, generally, new documents must be very well-polished, complete, and maintained in order to be accepted. ## Dependencies ## ### Unix ### -Jekyll is required. Follow the install instructions at the Jekyll [wiki](https://github.com/mojombo/jekyll/wiki/Install). In most cases, you can install via RubyGems: +Jekyll is required. Follow the install instructions at the Jekyll [wiki](https://github.com/mojombo/jekyll/wiki/Install). In most cases, you can install via RubyGems: gem install jekyll @@ -50,7 +50,7 @@ you have to execute `chcp 65001`. This command is best added to the `jekyll.bat` The markdown used in this site uses [Maruku](http://maruku.rubyforge.org/maruku.html) extensions. -### Markdwn Editor for OSX ### +### Markdown Editor for OSX ### There exists a free markdown editor for OSX called [Mou](http://mouapp.com/). It's quite convenient to work with, and it generates the translated Markdown in real-time alongside of your editor window, as can be seen here: @@ -58,4 +58,4 @@ There exists a free markdown editor for OSX called [Mou](http://mouapp.com/). It ## License ## -All documentation contained in this repository is licensed by EPFL under a Creative Commons Attribution-Share Alike 3.0 Unported license ("CC-BY-SA"), unless otherwise noted. By submitting a "pull request," or otherwise contributing to this repository, you implicitly agree to license your contribution under the above CC-BY-SA license. The source code of this website is licensed to EPFL under the [Scala License](http://www.scala-lang.org/node/146), unless otherwise noted. +All documentation contained in this repository is licensed by EPFL under a Creative Commons Attribution-Share Alike 3.0 Unported license ("CC-BY-SA"), unless otherwise noted. By submitting a "pull request," or otherwise contributing to this repository, you implicitly agree to license your contribution under the above CC-BY-SA license. The source code of this website is licensed to EPFL under the [Scala License](http://www.scala-lang.org/node/146), unless otherwise noted.