Changes between Version 11 and Version 12 of WikiStart

Timestamp:

09/04/10 00:01:58 (3 years ago)

Author:

stuge

Comment:

Restructure the page a little and add paragraphs about support and bugs

WikiStart

@@ -3 +3 @@
 == About ==
 
-This site is the home for the libusb project. It aims to create a library for use by user level applications to access USB devices regardless of OS. libusb is an open source project licensed under the [http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html GNU Lesser General Public License version 2.1].
+This is the home of libusb, a library for user level applications to access USB devices uniformly across many different operating systems. libusb is an open source project licensed under the [http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html GNU Lesser General Public License version 2.1].
 
-== Status ==
+Many participants in the libusb community have helped and continue to help with ideas, implementation, support and improvements for libusb.
 
-Johannes Erdfelt founded the project and lead development through 2007. During this time, libusb-0.1 was developed, stabilised, and adopted by a wide range of projects. Development slowed from that point.
+== Stable API: libusb-1.0 ==
 
-Daniel Drake adopted the project in January 2008 to develop libusb-1.0. This new branch adds features missing from the first release.
-
-== Stable release ==
-
-As of December 2008, [wiki:Libusb1.0 libusb-1.0] is the current stable branch. Developers are encouraged to port their applications.
+Daniel Drake adopted the project in January 2008 and worked on a [wiki:Libusb1.0 libusb-1.0] release, which adds several features that were missing from the 0.1 API. As of December 2008, libusb-1.0 is the stable and recommended version to use. Developers are encouraged to port their applications to the new API.
 
  * ''See the [wiki:Libusb1.0] page for more information.''
- * [http://sourceforge.net/project/showfiles.php?group_id=1674&package_id=277626 Source download]
- * [http://libusb.sourceforge.net/api-1.0/ API documentation]
+ * [http://sourceforge.net/project/showfiles.php?group_id=1674&package_id=277626 Download libusb-1.0 releases here]
+ * [api-1.0: API documentation]
  * Compatibility with libusb-0.1 is available through the [wiki:LibusbCompat0.1 libusb-compat-0.1 compatibility layer].
+ * The [wiki:windows_backend Windows backend] uses WinUSB.sys or Win32 HID APIs, it is considered functional as of June 2010 and is being integrated into the main libusb-1.0 tree.
 
-== Legacy release ==
+== Legacy API: libusb-0.1 ==
 
- * Latest version: [http://sourceforge.net/project/showfiles.php?group_id=1674&package_id=1632&release_id=398442 v0.1.12]
- * Supported operating systems: Linux, FreeBSD, NetBSD, OpenBSD, Darwin, MacOS X (and Windows through the [http://sourceforge.net/apps/trac/libusb-win32/wiki libusb-win32 project]). Brief introduction of libusb-win32 is also located in the [wiki:libusb-win32 wiki page here].
- * [http://sourceforge.net/project/showfiles.php?group_id=1674 Download here]
- * [http://libusb.sourceforge.net/doc/ API documentation]
- * [http://sourceforge.net/apps/trac/libusb-win32/wiki/libusbwin32_examples Unofficial bindings]
- * [http://sourceforge.net/apps/trac/libusb-win32/wiki/libusbwin32_examples Projects and Examples using libusb-0.1 and libusb-win32]
- * Development status: this branch has reached maturity, it is unlikely that further releases will happen
+Johannes Erdfelt founded the libusb project and lead development through 2007. By then, libusb-0.1 had been developed, stabilized, and adopted by a wide range of projects.
 
-== Unstable development branches ==
+ * Last release: [http://sourceforge.net/project/showfiles.php?group_id=1674&package_id=1632&release_id=398442 libusb-0.1.12]
+ * Supported operating systems: Linux, FreeBSD, NetBSD, OpenBSD, Darwin, MacOS X (and Windows, through the [wiki:libusb-win32] project).
+ * Development status: libusb-0.1 has reached maturity and no further changes or releases are expected.
+ * Note that [wiki:libusb-win32] is a separate project which still sees some development. Once libusb-1.0 supports the libusb0.sys device driver (#49) then the focus might shift to libusb-1.0 also for remaining libusb-win32 users.
+ * [http://sourceforge.net/project/showfiles.php?group_id=1674 Download libusb-0.1 releases here]
+ * [doc-0.1: API documentation]
+ * [libusb-win32:libusbwin32_examples Unofficial bindings], at the libusb-win32 site
+ * [libusb-win32:libusbwin32_examples Projects and Examples using libusb-0.1 and libusb-win32]
 
-Since December 2009, the following branch is also experiencing active development. As of June 2010, it is considered functional and is in the process of being integrated in the main tree.
+== Support ==
 
- * [wiki:windows_backend Windows backend]: A project to bring a Windows backend to libusb 1.0.
+Please ask support questions on the [wiki:MailingList mailing list] or in the [wiki:IRC IRC channel].
 
-== Mailing list ==
+== Bugs and feature requests ==
 
-The libusb-devel mailing list exists for both users of the library, plus developers interested in contributing to the library itself.
- * [http://lists.sourceforge.net/mailman/listinfo/libusb-devel Subscribe]
- * [http://sourceforge.net/mailarchive/forum.php?forum_name=libusb-devel Archives at SourceForge]
- * [http://news.gmane.org/gmane.comp.lib.libusb.devel.general Archives at GMANE]
- * [http://libusb.6.n5.nabble.com/LibUSB-Dev-f7.html Archives at Nabble]
+If you find a bug in libusb, or wish to request an enhancement, please open a ticket on this web page.
+
+Make sure to view [/report/1 the list of active tickets] before [/newticket creating a new ticket], so that duplicates can be avoided.
+
+Thank you for helping make libusb even better!
 
 == Related ==
 
- * [http://sourceforge.net/projects/linux-usb/files/usbutils/ usbutils]
- * [http://www.linux-usb.org/ Linux-USB]
+ * [http://sourceforge.net/projects/linux-usb/files/usbutils/ usbutils] includes the very useful lsusb program to view descriptors in devices