Skip to content

Commit f2053ac

Browse files
committed
update README: documentation & contributing
1 parent 7168c9a commit f2053ac

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
scala-parser-combinators [<img src="https://api.travis-ci.org/scala/scala-parser-combinators.png"/>](https://travis-ci.org/scala/scala-parser-combinators)
22
========================
33

4-
Scala Standard Parser Combinator Library
4+
### Scala Standard Parser Combinator Library
55

66
As of Scala 2.11, this library is a separate jar that can be omitted from Scala projects that do not use Parser Combinators.
77

8+
## Documentation
9+
10+
* [Latest version](http://www.scala-lang.org/files/archive/api/2.11.2/scala-parser-combinators/)
11+
* [Previous versions](http://scala-lang.org/documentation/api.html) (included in the API docs for the Scala library until Scala 2.11)
12+
813
## Adding an SBT dependency
914
To depend on scala-parser-combinators in SBT, add something like this to your build.sbt:
1015

@@ -15,3 +20,8 @@ libraryDependencies += "org.scala-lang.modules" %% "scala-parser-combinators" %
1520
(Assuming you're using a `scalaVersion` for which a scala-parser-combinators is published. The first 2.11 milestone for which this is true is 2.11.0-M4.)
1621

1722
To support multiple Scala versions, see the example in https://github.com/scala/scala-module-dependency-sample.
23+
24+
## Contributing
25+
26+
* See the [Scala Developer Guidelines](https://github.com/scala/scala/blob/2.12.x/CONTRIBUTING.md) for general contributing guidelines
27+
* Have a look at [existing issues](https://issues.scala-lang.org/issues/?filter=12606)

0 commit comments

Comments
 (0)