Skip to content

update README: documentation & contributing #24

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
Jul 25, 2014
Merged
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
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
scala-parser-combinators [<img src="https://api.travis-ci.org/scala/scala-parser-combinators.png"/>](https://travis-ci.org/scala/scala-parser-combinators)
========================

Scala Standard Parser Combinator Library
### Scala Standard Parser Combinator Library

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

## Documentation

* [Latest version](http://www.scala-lang.org/files/archive/api/2.11.2/scala-parser-combinators/)
* [Previous versions](http://scala-lang.org/documentation/api.html) (included in the API docs for the Scala library until Scala 2.11)

## Adding an SBT dependency
To depend on scala-parser-combinators in SBT, add something like this to your build.sbt:

Expand All @@ -15,3 +20,8 @@ libraryDependencies += "org.scala-lang.modules" %% "scala-parser-combinators" %
(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.)

To support multiple Scala versions, see the example in https://github.com/scala/scala-module-dependency-sample.

## Contributing

* See the [Scala Developer Guidelines](https://github.com/scala/scala/blob/2.12.x/CONTRIBUTING.md) for general contributing guidelines
* Have a look at [existing issues](https://issues.scala-lang.org/issues/?filter=12606)