Skip to content

Commit

Permalink
Set version to 1.1.0; updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
laughedelic committed Jul 21, 2013
1 parent 9d12102 commit c017f00
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,16 @@ Comments are passed through
highlighted using [google-code-prettify](http://code.google.com/p/google-code-prettify/)
syntax highlighting.

Currently, to build Scalocco, you'll need **maven** and **scala**. The project
depends on [scala-mustache](https://github.com/vspy/scala-mustache) and
[Markdown4j](https://code.google.com/p/markdown4j/)
Currently, to build Scalocco, you'll need [sbt](http://www.scala-sbt.org/release/docs/Getting-Started/Setup.html) and **scala**. The project
depends on [scala-mustache](https://github.com/vspy/scala-mustache) and [Markdown4j](https://code.google.com/p/markdown4j/)

To use Scalocco, build it using `maven` (no `sbt` for now) then run it from the command-line:
To run Scalocco, just use sbt:

java -jar scalocco.jar /path/to/scala/files
sbt "run /path/to/scala/files"

...will generate linked HTML documentation for the named source files, saving
it into a `docs` folder.

The visual style was borrowed from the .Net implementation of Docco: [Nocco](https://github.com/dontangg/nocco)

You can see the result of running Scalocco on its own source code here: [http://grison.me/scalocco/source](http://grison.me/scalocco/source)
You can see the result of running Scalocco on its own source code here: [http://grison.me/scalocco/source](http://grison.me/scalocco/source)
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ startYear := Some(2013)

// licenses += ???

version := "1.1.0-SNAPSHOT"
version := "1.1.0"

scalaVersion := "2.10.1"

Expand Down

0 comments on commit c017f00

Please sign in to comment.