Skip to content

Commit 0a66e6c

Browse files
authored
round of readme tweaks
1 parent 07ce708 commit 0a66e6c

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,19 @@
55
[<img src="https://img.shields.io/maven-central/v/org.scala-lang.modules/scala-swing_2.12.svg?label=latest%20release%20for%202.12"/>](http://search.maven.org/#search%7Cga%7C1%7Cg%3Aorg.scala-lang.modules%20a%3Ascala-swing_2.12)
66
[![Stories in Ready](https://badge.waffle.io/scala/scala-swing.svg?label=ready&title=Ready)](http://waffle.io/scala/scala-swing)
77

8-
This is now community maintained by @benhutchison & @Sciss. If you are interested in helping then contact them or @adriaanm.
8+
This is now community maintained by [@Sciss](https://github.com/Sciss) and [@benhutchison](https://github.com/benhutchison). If you are interested in helping then contact them or [@adriaanm](https://github.com/adriaanm).
99

10-
This is a UI library that will wrap most of Java Swing for Scala in a straightforward manner.
10+
## Adding an sbt dependency
11+
12+
To use scala-swing from sbt, add this to your `build.sbt`:
13+
14+
```
15+
libraryDependencies += "org.scala-lang.modules" %% "scala-parser-combinators" % "2.1.1"
16+
```
17+
18+
## About scala-swing
19+
20+
This is a UI library that wraps most of Java Swing for Scala in a straightforward manner.
1121
The widget class hierarchy loosely resembles that of Java Swing. The main differences are:
1222

1323
- In Java Swing all components are containers per default. This does not make much sense for
@@ -98,11 +108,11 @@ new Frame {
98108

99109
## Versions
100110

101-
- The `1.0.x` branch is compiled with JDK 6 and released for Scala 2.10, 2.11. The 1.0.x releases can be used with both Scala versions on JDK 6 or newer.
111+
- The `1.0.x` branch is compiled with JDK 6 and released for Scala 2.11 and 2.11. The 1.0.x releases can be used with both Scala versions on JDK 6 or newer.
102112
- The `2.0.x` branch is compiled with JDK 8 and released for Scala 2.11 and 2.12.
103113
- When using Scala 2.11, you can use the Scala swing 2.0.x releases on JDK 6 or newer.
104114
- Scala 2.12 requires you to use JDK 8 (that has nothing to do with scala-swing).
105-
- Version `2.1.0` adds support for Scala 2.13, while dropping Scala 2.10.
115+
- The `2.1.x` series adds support for Scala 2.13, while dropping Scala 2.10.
106116

107117
The reason to have different major versions is to allow for binary incompatible changes. Also, some java-swing classes were
108118
generified in JDK 7 (see [SI-3634](https://issues.scala-lang.org/browse/SI-3634)) and require the scala-swing sources to be adjusted.
@@ -117,4 +127,4 @@ at [http://www.scala-lang.org/documentation/api.html](http://www.scala-lang.org/
117127
## Current Work
118128

119129
Current changes are being made on the `work` branch.
120-
Last published version is found on the `main` branch.
130+
Last published version is found on the `main` branch.

0 commit comments

Comments
 (0)