Alexandre Julliard : Documentation updates.

Alexandre Julliard julliard at wine.codeweavers.com
Wed Aug 23 16:36:14 CDT 2006


Module: wine
Branch: master
Commit: 4e4740346df5bccff744d0c389740cad62f2daa3
URL:    http://source.winehq.org/git/?p=wine.git;a=commit;h=4e4740346df5bccff744d0c389740cad62f2daa3

Author: Alexandre Julliard <julliard at winehq.org>
Date:   Wed Aug 23 15:59:14 2006 +0200

Documentation updates.

---

 README             |   56 +++++++++++++++++++++++-----------------------------
 loader/wine.man.in |    4 ++--
 2 files changed, 27 insertions(+), 33 deletions(-)

diff --git a/README b/README
index 029f592..2c4078f 100644
--- a/README
+++ b/README
@@ -10,6 +10,7 @@ be used for porting Win32 code into nati
 Wine is free software, released under the GNU LGPL; see the file
 LICENSE for the details.
 
+
 2. QUICK START
 
 Whenever you compile from source, it is recommended to use the Wine
@@ -18,10 +19,11 @@ of the Wine source (which contains this 
 
 ./tools/wineinstall
 
-Run programs as "wine [options] program".  For more information and
-problem resolution, read the rest of this file, the Wine man page, and
+Run programs as "wine program".  For more information and problem
+resolution, read the rest of this file, the Wine man page, and
 especially the wealth of information found at http://www.winehq.org.
 
+
 3. REQUIREMENTS
 
 To compile and run Wine, you must have one of the following:
@@ -30,6 +32,7 @@ To compile and run Wine, you must have o
   FreeBSD 5.3 or later
   Solaris x86 2.5 or later
   NetBSD-current
+  MacOS X 10.4 or later
 
 As Wine requires kernel-level thread support to run, only the operating
 systems mentioned above are supported.
@@ -58,6 +61,8 @@ NetBSD info:
   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
   turned on in your kernel.
 
+MacOS info:
+  You need Xcode 2.4 or later to build properly on x86.
 
 
 Supported file systems:
@@ -76,17 +81,16 @@ Build tool requirements:
   On x86 Systems gcc >= 2.7.2 is required.
   Versions earlier than 2.7.2.3 may have problems when certain files
   are compiled with optimization, often due to problems with header file
-  management. pgcc currently doesn't work with Wine. The cause of this problem
-  is unknown.
+  management.
 
   Of course you also need "make" (most likely GNU make).
 
   You also need flex version 2.5 or later and bison.
 
 Optional support libraries:
-  If you want CUPS printing support, please install both cups and cups-devel
-  packages.
-  Install the libxml2 package to get a functional msxml implementation.
+  Run ./configure --verbose to see the optional libraries that could
+  be used but aren't found on your system.
+
 
 4. COMPILATION
 
@@ -108,12 +112,13 @@ To upgrade to a new release by using a p
 top-level directory of the release (the one containing this README
 file). Then do a "make clean", and patch the release with:
 
-    gunzip -c patch-file | patch -p1
+    bunzip2 -c patch-file | patch -p1
 
 where "patch-file" is the name of the patch file (something like
-Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
+wine-0.9.x.diff.bz2). You can then re-run "./configure", and then
 run "make depend && make".
 
+
 5. SETUP
 
 Once Wine has been built correctly, you can do "make install"; this
@@ -131,6 +136,7 @@ In case of library loading errors
 (e.g. "Error while loading shared libraries: libntdll.so"), make sure
 to add the library path to /etc/ld.so.conf and run ldconfig as root.
 
+
 6. RUNNING PROGRAMS
 
 When invoking Wine, you may specify the entire path to the executable,
@@ -148,23 +154,11 @@ For example: to run Solitaire:
         wine sol.exe /parameter1 -parameter2 parameter3
 				   (calling program with parameters)
 
-Note: the path of the file will also be added to the path when
-      a full name is supplied on the commandline.
-
-Wine is not yet complete, so several programs may crash. Provided you set up
-winedbg correctly according to documentation/debugger.sgml, you will be dropped
-into a debugger so that you can investigate and fix the problem.
-For more information on how to do this, please read the file
-documentation/debugging.sgml.
+Wine is not yet complete, so several programs may crash. In that crash
+you will be dropped into the debugger so that you can investigate and
+fix the problem.  For more information on how to do this, please check
+the debugging section of the Wine Developer's Guide.
 
-You should backup all your important files that you give Wine access
-to, or use a special Wine copy of them, as there have been some cases
-of users reporting file corruption. Do NOT run Explorer, for instance,
-if you don't have a proper backup, as it renames/cripples several
-directories sometimes. Not even other MS apps such as e.g. Messenger are safe,
-as they launch Explorer somehow. This particular corruption (!$!$!$!$.pfr)
-can at least partially be fixed by using
-http://home.nexgo.de/andi.mohr/download/decorrupt_explorer
 
 7. GETTING MORE INFORMATION
 
@@ -181,17 +175,17 @@ Bugs:	Report bugs to Wine Bugzilla at ht
 	Please search the bugzilla database to check whether your
 	problem is already found before posting a bug report.  You can
 	also post bug reports to comp.emulators.ms-windows.wine.
-	Please read the file documentation/bugs.sgml to see what
-	information is required.
 
 IRC:	Online help is available at channel #WineHQ on irc.freenode.net.
 
-CVS:	The current Wine development tree is available through CVS.
-	Go to http://www.winehq.org/cvs for more information.
+GIT:	The current Wine development tree is available through GIT.
+	Go to http://www.winehq.org/site/git for more information.
 
 Mailing lists:
-	There are several mailing lists for Wine developers; see
-	http://www.winehq.org/forums for more information.
+	There are several mailing lists for Wine users and developers;
+	see http://www.winehq.org/forums for more information.
+
+Wiki:	The Wine Wiki is located at http://wiki.winehq.org
 
 If you add something, or fix a bug, please send a patch (in 'diff -u'
 format) to wine-patches at winehq.org list for inclusion in the next
diff --git a/loader/wine.man.in b/loader/wine.man.in
index 927bbe3..efc344b 100644
--- a/loader/wine.man.in
+++ b/loader/wine.man.in
@@ -280,10 +280,10 @@ The most recent public version of 
 can be downloaded from
 .I http://www.winehq.org/download
 .PP
-The latest snapshot of the code may be obtained via CVS.  For information
+The latest snapshot of the code may be obtained via GIT.  For information
 on how to do this, please see
 .I
-http://www.winehq.org/cvs
+http://www.winehq.org/site/git
 .PP
 WineHQ, the
 .B wine




More information about the wine-cvs mailing list