Test patch

Joshua Reisenauer kd7tck at gmail.com
Sat Jun 20 21:37:00 CDT 2009


I am sending this test patch to see if I used the correct formatting.  I
would like feedback on what the wine dev community likes and doesn't like in
patches.  For example do you prefer .txt or .patch?
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://www.winehq.org/pipermail/wine-patches/attachments/20090620/f6b995bf/attachment-0001.htm>
-------------- next part --------------
From 67dd076785c145c5404a38c41773588e3ec50094 Mon Sep 17 00:00:00 2001
From: Joshua Adam Reisenauer <kd7tck at gmail.com>
Date: Sat, 20 Jun 2009 21:15:49 -0500
Subject: [PATCH] Formatting and sentence structure modified for README.

---
 README |   64 ++++++++++++++++++++++++++++++++++++----------------------------
 1 files changed, 36 insertions(+), 28 deletions(-)

diff --git a/README b/README
index 1f6c384..0d488d9 100644
--- a/README
+++ b/README
@@ -1,9 +1,9 @@
 1. INTRODUCTION
 
 Wine is a program which allows running Microsoft Windows programs
-(including DOS, Windows 3.x and Win32 executables) on Unix.  It
+(Including DOS, Windows 3.x and Win32 executables) on Unix.  It
 consists of a program loader which loads and executes a Microsoft
-Windows binary, and a library (called Winelib) that implements Windows
+Windows binary and a library (called Winelib) that implements Windows
 API calls using their Unix or X11 equivalents.  The library may also
 be used for porting Win32 code into native Unix executables.
 
@@ -13,11 +13,11 @@ LICENSE for the details.
 
 2. QUICK START
 
-Whenever you compile from source, it is recommended to use the Wine
-Installer to build and install Wine.  From the top-level directory
-of the Wine source (which contains this file), run:
+Use the Wine Installer to build and install Wine, when compiling from source.
+Do so from the top-level directory of the Wine source (which contains this file), 
+run:
 
-./tools/wineinstall
+	./tools/wineinstall
 
 Run programs as "wine program".  For more information and problem
 resolution, read the rest of this file, the Wine man page, and
@@ -50,7 +50,7 @@ FreeBSD info:
 
 Solaris info:
   You will most likely need to build Wine with the GNU toolchain
-  (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
+  (gcc, gas, etc...). Warning: installing gas does *not* ensure that it
   will be used by gcc. Recompiling gcc after installing gas or
   symlinking cc, as and ld to the gnu tools is said to be necessary.
 
@@ -88,25 +88,29 @@ Optional support libraries:
 
 4. COMPILATION
 
-In case you chose to not use wineinstall, run the following commands
+If you chose not to use wineinstall, run the following commands
 to build Wine:
 
-./configure
-make depend
-make
+	./configure
+	make depend
+	make
 
 This will build the program "wine" and numerous support libraries/binaries.
 The program "wine" will load and run Windows executables.
 The library "libwine" ("Winelib") can be used to compile and link
-Windows source code under Unix.
+Windows source code under Unix.  To install wine from this build, 
+refer ahead to part 5 of this document.
 
-To see compile configuration options, do ./configure --help.
+To see compile configuration options, do:
+
+	./configure --help
 
 To upgrade to a new release by using a patch file, first cd to the
 top-level directory of the release (the one containing this README
-file). Then do a "make clean", and patch the release with:
+file). Then run the following commands to patch the release:
 
-    bunzip2 -c patch-file | patch -p1
+	make clean
+	bunzip2 -c patch-file | patch -p1
 
 where "patch-file" is the name of the patch file (something like
 wine-1.0.x.diff.bz2). You can then re-run "./configure", and then
@@ -115,14 +119,17 @@ run "make depend && make".
 
 5. SETUP
 
-Once Wine has been built correctly, you can do "make install"; this
-will install the wine executable, the Wine man page, and a few other
-needed files.
-
-Don't forget to uninstall any conflicting previous Wine installation
-first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
+Before installing, don't forget to uninstall any conflicting previous Wine 
+installation.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall" 
 before installing.
 
+Once Wine has been built correctly, you can do:
+
+	make install
+
+This will install the wine executables, the Wine man page, and a few other
+needed files.
+
 Once installed, you can run the "winecfg" configuration tool. See the
 Support area at http://www.winehq.org/ for configuration hints.
 
@@ -134,27 +141,28 @@ or a filename only.
 
 For example: to run Notepad:
 
-	wine notepad		   (using the search Path as specified in
+	wine notepad		(using the search Path as specified in
 	wine notepad.exe	    the config file to locate the file)
 
 	wine c:\\windows\\notepad.exe  (using DOS filename syntax)
 
 	wine ~/.wine/drive_c/windows/notepad.exe  (using Unix filename syntax)
 
-        wine notepad.exe /parameter1 -parameter2 parameter3
-				   (calling program with parameters)
+	wine notepad.exe /parameter1 -parameter2 parameter3
+					(calling program with parameters)
 
-Wine is not yet complete, so several programs may crash. In that crash
+Wine is not yet complete and 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.
+the debugging section of the Wine Developer's Guide. Visit
+< http://www.winehq.org/docs/winedev-guide/debugger> to learn more.
 
 
 7. GETTING MORE INFORMATION
 
 WWW:	A great deal of information about Wine is available from WineHQ at
-	http://www.winehq.org/ : various Wine Guides, application database,
-	bug tracking. This is probably the best starting point.
+	<http://www.winehq.org/>, for various Wine Guides, application database, 
+	bug tracking.  This is probably the best starting point.
 
 FAQ:	The Wine FAQ is located at http://www.winehq.org/FAQ
 
-- 
1.6.3.2.1299.gee46c
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-Formatting-and-sentence-structure-modified-for-READM.patch
Type: application/octet-stream
Size: 5630 bytes
Desc: not available
URL: <http://www.winehq.org/pipermail/wine-patches/attachments/20090620/f6b995bf/attachment-0001.obj>


More information about the wine-patches mailing list