Skip to content

Commit 81b05dc

Browse files
committed
Update README.md
1 parent e7b5c87 commit 81b05dc

File tree

1 file changed

+20
-29
lines changed

1 file changed

+20
-29
lines changed

README.md

+20-29
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
1-
scala-swing (mostly-unsupported)
2-
=========
1+
# scala-swing (mostly-unsupported)
32

43
[<img src="https://img.shields.io/travis/scala/scala-swing/java7.svg"/>](https://travis-ci.org/scala/scala-swing)
54
[<img src="https://img.shields.io/maven-central/v/org.scala-lang.modules/scala-swing_2.11.svg?label=latest%20release%20for%202.11"/>](http://search.maven.org/#search%7Cga%7C1%7Cg%3Aorg.scala-lang.modules%20a%3Ascala-swing_2.11)
65
[<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*)
76
[![Stories in Ready](https://badge.waffle.io/scala/scala-swing.svg?label=ready&title=Ready)](http://waffle.io/scala/scala-swing)
87
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/scala/scala-swing)
98

10-
This is now community maintained. If you're interested in helping then contact @adriaanm or @andy1138
11-
Questions can asked on the [Google Group](https://groups.google.com/forum/#!forum/scala-swing)
9+
This is now community maintained. If you're interested in helping then contact @adriaanm or @andy1138.
10+
Questions can asked on the [Google Group](https://groups.google.com/forum/#!forum/scala-swing).
1211

1312
This is a UI library that will wrap most of Java Swing for Scala in a straightforward manner.
1413
The widget class hierarchy loosely resembles that of Java Swing. The main differences are:
1514

1615
- In Java Swing all components are containers per default. This doesn't make much sense for
1716
a number of components, like TextField, CheckBox, RadioButton, and so on. Our guess is that
1817
this architecture was chosen because Java lacks multiple inheritance.
19-
In scala.swing, components that can have child components extend the Container trait.
18+
In scala-swing, components that can have child components extend the Container trait.
2019
- Layout managers and panels are coupled. There is no way to exchange the layout manager
2120
of a panel. As a result, the layout constraints for widgets can be typed.
2221
(Note that you gain more type-safety and don't loose much flexibility here. Besides
@@ -25,22 +24,20 @@ The widget class hierarchy loosely resembles that of Java Swing. The main differ
2524
child component. In the end, it is not more work to move all children to a newly created
2625
panel.)
2726

28-
The event system. TODO
27+
The event system. TODO.
2928

3029
- For more details see [SIP-8](docs/SIP-8.md)
3130

32-
The library comprises three main packages:
31+
The library comprises two main packages:
3332

3433
- `scala.swing`: All widget classes and traits.
3534
- `scala.swing.event`: The event hierarchy.
3635

3736

38-
Examples
39-
---
37+
## Examples
4038

4139
A number of examples can be found in the `examples` project.
42-
A good place to start is `[12] scala.swing.examples.UIDemo` (_index number may be different for you_). This gives pulls in the all the other examples into a tabbed window.
43-
40+
A good place to start is `[12] scala.swing.examples.UIDemo` (_index number may be different for you_). This pulls in the all the other examples into a tabbed window.
4441

4542
```
4643
$ sbt examples/run
@@ -68,33 +65,27 @@ Enter number:
6865
```
6966

7067

71-
72-
73-
Versions
74-
---
68+
## Versions
7569

76-
- Version 1.xx.xx branch is compiled with java6,
77-
- Version 2.xx.xx compiled with java7, targeted to java6.
78-
79-
_Reason for different versions can be found at [SI-3634](https://issues.scala-lang.org/browse/SI-3634)_
80-
70+
- 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.
71+
- The `2.0.x` branch is compiled with JDK 8 and released for Scala 2.11 and 2.12.
72+
- When using Scala 2.11, you can use the Scala swing 2.0.x releases on JDK 6 or newer.
73+
- Scala 2.12 requires you to use JDK 8 (that has nothing to do with scala-swing).
8174

75+
The reason to have two versions is to allow for binary incompatible changes. Also, some java-swing classes were generified in JDK 7 (see [SI-3634](https://issues.scala-lang.org/browse/SI-3634)) and require the scala-swing soruces to be adjusted.
8276

83-
ScalaDocs
84-
---
8577

86-
Documentation for scala-swing included in 2.11.1 is can be found [here](http://www.scala-lang.org/api/2.11.1/scala-swing/#scala.swing.package)
78+
## API documentation (Scaladoc)
8779

88-
Other version can be found at [http://www.scala-lang.org/documentation/api.html](http://www.scala-lang.org/documentation/api.html)
80+
The API documentation for scala-swing can be found at [http://www.scala-lang.org/documentation/api.html](http://www.scala-lang.org/documentation/api.html).
8981

9082

91-
Current Work
92-
---
83+
## Current Work
9384

94-
Current changes are being made on the **java7** branch. This is to mainly because of the EOL of java6 and the generification that happened between jdk6 and jdk7 requiring a difference in the source code. This class files are targeted at java6 and will run with all versions upwards.
85+
Current changes are being made on the `2.0.x` branch.
9586

96-
<br>
9787

98-
_Notes:_
88+
## Known Issues
9989

10090
- Visual appearance of combo boxes using the GTK LaF is broken on JDKs < 1.7b30. This is a Java Swing problem.
91+
whe

0 commit comments

Comments
 (0)