Merge lp:~jameinel/ubuntuone-windows-installer/readme_fixes into lp:ubuntuone-windows-installer/beta

[John A Meinel]

Cleanup README.txt a bit, for English and line width.

Some cleanups to the README.txt. Lines are wrapped to ~80 chars, and the English is cleaned up a bit.

[Manuel de la Peña (mandel)]

+1 thx!

review: Approve

[Vincenzo Di Somma (vds)]

review: Approve

=== modified file 'README.txt'
--- README.txt	2010-08-27 14:43:32 +0000
+++ README.txt	2010-11-19 16:20:40 +0000
@@ -1,30 +1,36 @@
 1. Introduction
 
-This solution provides all the infrastruture changes that are required to run Ubuntu One on Windows. In order to
-do this the solution provides the following:
-
-	* Unbutu One sync daemon: The daemon that will be performing the file sync.
-	* UbuntuOne Windows Service: Windows service that allows to start, stop, pause and resume the sync daemon.
-	* UbuntuOne Windows Service Brodcaster: Provides a WCF service hosted in a windows service that allows to .Net languages
-	  to communicate with the sync daemon and interact with it.
-
-2. Enviroment setup
-
-The ubuntuone windows port solution provides a port of the python code that is used on Linux to perform the u1 sync operations. Due to the fact that 
-we did not want user to have to be hunting down the python runtime plus the differen modules that have been used. To simplify the live of the 
-windows users we have opted to use py2exe to create an executable that will carry all the different python dependencies of the code. As you
-may already know py2exe is not perfect and does not support egg files. In order to make sure that you easy_install does extra the eggs files after
-the packages are installed please use the following command:
+This solution provides all the infrastructure changes that are required to run
+Ubuntu One on Windows. To do this we provide the following:
+
+	* UbuntuOne sync daemon: The daemon that will be performing the file sync.
+    * UbuntuOne Windows Service: Windows service that allows to start, stop,
+      pause and resume the sync daemon.
+    * UbuntuOne Windows Service Brodcaster: Provides a WCF service hosted in a
+      windows service that allows .Net languages to communicate with the sync
+      daemon and interact with it.
+
+2. Environment setup
+
+The UbuntuOne windows port provides a port of the python code that is used on
+Linux to perform the U1 sync operations. We did not want to request that the
+user hunt down both the python runtime and necessary dependencies. To simplify
+the life of the windows users we have opted to use py2exe to create an
+executable that will carry all the different python dependencies of the code.
+As you may already know, py2exe is not perfect and does not support egg files.
+So when using easy_install to install packages, use the following command:
 
 easy_install -Z %package_name%
 
-In order to be able to build the solution you will need to have python win32, the win32 python extensions and the ubuntu one storage protocol in your system.:
+To build the solution you will need to have python win32, the win32 python
+extensions and the UbuntuOne storage protocol on your system.:
 
 
 3. Build
 
-In order to simplify the buil as much as possible, all the required tools for the compilation of the project are provided in the soruce tree. The 
-compilation uses a nant project that allows to run the following targets:
+To simplify the build, all tools required to compile the project are provided
+in the source tree. Compilation uses a nant project supporting the following
+targets:
 
 	2.1 clean
 
@@ -32,40 +38,46 @@
 
 	2.2 generate_protos
 
-	The project uses protobuffer for IPC. This target will compile the .cs files that generate the protbuffers code that is later 
-	compiled.
+    The project uses protobuffer for IPC. This target will compile the .cs
+    files that generate the protbuffers code that is later compiled.
 
 	2.3 build
 
-	Compiles the solution ensuring that the protobuffer are generated using the protobuffer compiler. Once the protobuffer are generated the
-	target will compile the solution using MSBuild
+    Compiles the solution ensuring that the protobuffer are generated using the
+    protobuffer compiler. Once the protobuffer are generated the target will
+    compile the solution using MSBuild
 
 	2.4 tests
 
-	Compiles the solution using the "build" target and runs the unit tests. The output of the unit tests will be placed in a newly created dir at the 
-	root called "test-results".
+    Compiles the solution using the "build" target and runs the unit tests. The
+    output of the unit tests will be placed in a newly created dir at the root
+    called "test-results".
 	
 	2.5 installer
 	
-	Creates an msi installer that can be used to install Ubuntu One in a windows machine.
+    Creates an msi installer that can be used to install UbuntuOne on a
+    windows machine.
 	
 	2.6 bootstrapper
 	
-	Crates a boot strapper that will allow to install a bundle with UbuntuOne that includes Tomboy and Gtk sharp if needed.
+    Crates a boot strapper that will allow to install a bundle with UbuntuOne
+    that includes Tomboy and Gtk sharp if needed.
 	
 	2.7 create_update
 	
-	Creates the msi that will be used to update the application, updates the rss used to notify updates an uploads the data to the server.
+    Creates the msi that will be used to update the application, update the
+    RSS feed with the new version, and upload the package to the server.
 	
-	Bare in mind that to be able to execute create_update you have to have the rights to update the data in canonicals S3. In order to do that 
-	you have to set the following enviroment valirables in your windows machine:
+    Bear in mind that to execute create_update you have to have the access
+    rights to update the data in Canonical's S3. You will need to
+    set the following environment variables on your windows machine:
 	
 	AWS_ACCESS_KEY_ID: The account Id
 	AWS_SECRET_ACCESS_KEY: The secret required to use the account.
 	
-	In order to run the script you will need to have boto () to be able to use S3.
+    The script requires the python package boto to interact with S3.
 
-In order to execute the build script execute at the root of the project
+To execute the build script, cd to the root of the project and execute:
 
 tools\Nant\bin\nant.exe <target>