Skip to content

Commit 54bed6f

Browse files
committed
Improve readme formatting and add information on Initiative 31 #1580
This enhances the readme in the following ways: - Use consistent markdown formatting throughout the document and change all headlines to title case - Add a section on prototyping work for a single, OS-agnostic SWT implementation with links to the according prototype repositories (Initiative 31) Fixes #1580
1 parent e6588c2 commit 54bed6f

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -76,22 +76,19 @@ Finally, we set the window's size determines by its child controls and open the
7676
The `while`-loop processes all GUI related events until the shell is disposed which happens when closing.
7777
Before exiting, any claimed GUI resources needs to be freed.
7878

79-
Contributing to SWT
80-
===================
79+
80+
# Contributing to SWT
8181

8282
Thanks for your interest in this project.
8383

8484
For information about contributing to Eclipse Platform in general, see the general [CONTRIBUTING](https://github.com/eclipse-platform/.github/blob/main/CONTRIBUTING.md) page.
8585

86-
8786
[![Create Eclipse Development Environment for Eclipse SWT](https://download.eclipse.org/oomph/www/setups/svg/SWT.svg)](
8887
https://www.eclipse.org/setups/installer/?url=https://raw.githubusercontent.com/eclipse-platform/eclipse.platform.swt/master/bundles/org.eclipse.swt.tools/Oomph/PlatformSWTConfiguration.setup&show=true
8988
"Click to open Eclipse-Installer Auto Launch or drag into your running installer")
9089

9190

92-
93-
Developer resources:
94-
--------------------
91+
## Developer Resources
9592

9693
See the following description for how to contribute a feature or a bug fix to SWT.
9794

@@ -101,32 +98,39 @@ Information regarding source code management, builds, coding standards, and more
10198

10299
- <https://projects.eclipse.org/projects/eclipse.platform.swt/developer>
103100

104-
Contributor License Agreement:
105-
------------------------------
101+
## Contributor License Agreement
106102

107103
Before your contribution can be accepted by the project, you need to create and electronically sign the Eclipse Foundation Contributor License Agreement (CLA).
108104

109105
- <http://www.eclipse.org/legal/CLA.php>
110106

111-
Contact:
112-
--------
107+
## Contact
113108

114109
Contact the project developers via the project's "dev" list.
115110

116111
- <https://accounts.eclipse.org/mailing-list/platform-dev>
117112

118-
Search for bugs:
119-
----------------
113+
## Search for Bugs
120114

121115
SWT used to track ongoing development and issues in Bugzilla .
122116

123117
- <https://bugs.eclipse.org/bugs/buglist.cgi?product=Platform&component=SWT>
124118

125-
Create a new bug:
126-
-----------------
119+
## Create a New Bug
127120

128121
You can register bugs and feature requests in the Github Issue Tracker. Remember that contributions are always welcome!
129122
- [View existing SWT issues](https://github.com/eclipse-platform/eclipse.platform.swt/issues)
130123
- [New SWT issue](https://github.com/eclipse-platform/eclipse.platform.swt/issues/new)
131124

132125
Please bear in mind that this project is almost entirely developed by volunteers. If you do not provide the implementation yourself (or pay someone to do it for you), the bug might never get fixed. If it is a serious bug, other people than you might care enough to provide a fix.
126+
127+
128+
# Prototyping on a Single, Cross-Platform SWT Implementation
129+
130+
There is current work on evaluating the feasibility of achieving a single, OS-agnostic implementation of SWT in order to reduce maintenance efforts, enable better look and feel, and improve configurability.
131+
The work on these prototypes and their documentation can currently be found in a dedicated GitHub organization: https://github.com/swt-initiative31
132+
133+
Actual prototyping work has been started on four technologies: Skia with Visual Class Library (VCL), Skia with custom-rendered widgets, GTK, and Swing\
134+
The prototypes for the following technologies are still under investigation, are further developed and can be tried out here:
135+
- Skia with custom-drawn widgets: https://github.com/swt-initiative31/prototype-skija
136+
- Cross-platform GTK: https://github.com/swt-initiative31/prototype-gtk

0 commit comments

Comments
 (0)