On Tuesday, June 20, 2000, "John R . Sheets" <[EMAIL PROTECTED]> wrote:
> 
> I'll throw together a basic framework for this and post it here for
> review (hopefully by tomorrow sometime).

Here's a rough proposal of a documentation suite for Wine:

--------------------------------------------------

OVERVIEW
 For beginning users; assumes Wine is already installed. Very simple
 language; task-based.

WINE INSTALLATION GUIDE
 For all users; includes FTP, CVS, Redhat, Debian, etc.
 Covers getting it on the system, but not personalizing it. 

WINE USER'S GUIDE
 For the day-to-day user; maintaining Wine on your system.  How to
 configure the basic services, like fonts, printing, multimedia.

WINE APPLICATIONS GUIDE
 For dealing with specific applications.

WINE PORTING GUIDE
 For developers trying to migrate their apps to UNIX, using Wine.

WINE DEVELOPER'S GUIDE
 For developers wanting to contribute to Wine.  How to submit patches,
 what policies to follow, how to debug, and a nice, juicy section on
 the Wine architecture.


OVERVIEW
========

1. Introduction
   - What is Wine?
   - How do I run Wine?

2. Running Wine
   - At the command line
   - From the GNOME Panel
   - From the KDE Panel (Taskbar?)


WINE INSTALLATION GUIDE
=======================

1. Introduction
   - What forms does Wine take?

2. Installing on Redhat/Mandrake/SUSE

3. Installing on Debian

4. Installing from FTP

5. Installing from CVS

6. Configuring Wine
   - Setting up wine.conf
   - With Windows Partition

7. Graphical Configuration
   - Using TkWineSetup
   - With GNOME Control Center (NYI)*
   - With KDE Control Panel (NYI)

8. Testing the installation
   - Checklist to verify
   - Running an app

*-Not Yet Implemented


WINE USER'S GUIDE
=================

1. Introduction

2. Running Wine
   - Simplest case
   - Command line parameters

3. Configuring Wine
   - Customizing .winerc
   - Builtin vs. native DLLs
   - x11drv
   - Look & feel
   - Keyboard

4. Networking

5. Printing

6. Fonts

7. Multimedia

8. Security

9. OpenGL

10. Troubleshooting
   - Making a bug report
   - Common debug flags


11. FAQ


WINE APPLICATIONS GUIDE
=======================

1. MS Office

2. Lotus Notes

3. Quicken

4. StarCraft

   ...


WINE PORTING GUIDE
==================

1. Introduction

2. Binary emulation

3. WineLib

4. FAQ


WINE DEVELOPER'S GUIDE
======================

I. Architecture
      1. The Wine Server
      2. DLLs in Wine
      3. Drivers
      4. The Kernel
      5. The graphics subsystem
      6. OLE Support
      7. Unicode

II. Debugging Wine
      8. Debugging channels
      9. The Wine debugger

III. Tools
     10. wrc
     11. wmc
     12. winapi_check
     13. build.c
     14. Misc. scripts

IV. Policies & Procedures
     15. Preparing a patch
     16. Documentation

--------------------------------------------------

John

-- 
[EMAIL PROTECTED]                            http://www.gnome.org
[EMAIL PROTECTED]                  http://www.worldforge.org

Reply via email to