wxWorkshop Files

wxWorkshop README
=================

Version 0.7, February 2002
==========================

This is an alpha snapshot, released to allow people to
get an idea of what wxWorkshop is about and to encourage
people to contribute.

So far there is little up-to-date documentation on what to try,
but this should change soon. Try creating new dialogs
(File | New... Resource) which will demonstrate a variety of
draggable windows and the dialog editor. See also the
screenshots on the web site.

Contents of this release
========================

bin/                ; Windows binaries for wxWorkshop, Tex2RTF,
                    ; Helpgen and Helpview
src/                ; Source for libraries
include/            ; Include directories for libraries
include/wx/         ; Include directories for libraries
ws/                 ; wxWorkshop source directory
samples/            ; Samples for libraries and WS
docs/               ; Documentation hierarchy
wx_contrib_mods/    ; Soon-to-be obsolete hierarchy containing
                    ; local version of XRC

For further details including instructions on compiling
wxWorkshop, please see:

- The wxWorkshop user guide;
- the PMF (Project Management Framework) user guide;
- the WSPP (wxWokshop Power Pack) user guide;
- the FL (frame layout library) user guide.

The user guides are in these directories:

docs/html/          ; HTML
docs/htmlhelp/      ; MS HTML Help
docs/htb/           ; wxWindows HTML Help, viewable with 'helpview'
docs/pdf/           ; Acrobat PDF (if available)

Status of wxWorkshop
====================

wxWorkshop is in a state of flux and many things need to be done,
including adding toolbars, rationalising menus, improving
documentation, modularising, re-engineering, and adding missing
functionality. So this snapshot is intended to give a flavour
of where it's at, rather than to provide a complete tool for
end-users.

How you can help
================

We need help in documenting, re-engineering and extending
wxWorkshop. So do please browse the code and documents to get
an overview of how it fits together, join the wxWorkshop
mailing list (see web site), and become a wxWorkshop team
member!

The benefits:

- you'll be helping to create a tool that will help you
  and other wxWindows users create even better wxWindows
  applications, with less hassle;

- you'll have access to and help develop several great
  libraries that make up wxWorkshop, and which can
  be used in your own applications. These include a source
  code parser, a docking window framework, project management
  framework for building your own IDE-style applications,
  and more;

- you'll be part of a team of talented and diverse developers,
  all keen to create great software.

We particularly need help with:

* Documenting existing code

  If you edit .tex files under the docs/latex hierarchy,
  you can use the supplied Tex2RTF utility to regenerate
  documents in a variety of formats (see makefile.vc and
  readme.txt in each doc source directory).

  You can also regenerate class reference .tex files with
  the supplied utility 'helpgen', after improving header
  file commenting.

* Tidying existing code

  We are in the process of making the wxWorkshop code more
  modular, which will make it easier to understand as well
  as available to non-wxWorkshop applications. You may be
  able to pick a service in wxWorkshop that can be made into
  its own library under src and include/wx.

* Adding toolbar support to PMF

  Currently menus are merged according to the currently
  active services, but there is no toolbar support.
  Please see the wxWorkshop user guide discussion section
  for comments on that.

* And more...

  We don't yet have an official to-do list or roadmap. But
  you can help us write one, and then help us achieve it!

For more information
====================

Please see the wxWorkshop web site:

  http://wxworkshop.sourceforge.net/

and subscribe to the wxWorkshop mailing list.


Thank you and good luck!

The wxWorkshop Team