docs
authormartinko <gamato@users.sf.net>
Tue, 5 Mar 2013 13:25:50 +0000 (14:25 +0100)
committermartinko <gamato@users.sf.net>
Tue, 5 Mar 2013 13:25:50 +0000 (14:25 +0100)
INSTALL
README

diff --git a/INSTALL b/INSTALL
index ce94e688135e558efb8c53bd8c709202c6a11182..44b11c0dfafdcc66cb75ceb11cd9f29e533d7cec 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -4,7 +4,7 @@
 
 Skytools modules use some other code to run, so you need to install the
 following dependencies on the system where you want to build and run
-skytool applications.
+skytools based applications.
 
 === Build dependencies ===
 
@@ -64,10 +64,10 @@ The following configure options are available:
 
 --prefix::
   Path prefix where to install skytools files (default: /usr/local)
-  
+
 --with-python::
   Name or full path of the Python executable to use. (default: python)
-  
+
 --with-pgconfig::
   Name or full path to pg_config (default: pg_config)
 
@@ -75,6 +75,16 @@ The following configure options are available:
   If asciidoc should be used to re-generate manpages.  Required when
   building from GIT as the generated pages are not in repo.
 
+== Building without Makefile ==
+
+It is possible to build and install Python part of Skytools only.
+This is useful when no required build / devel tools (dependencies)
+are available (typically on Windows platform).
+
+Commands to run vary across platforms but usually go like this:
+
+  $ [sudo] python setup_pkgloader.py install
+  $ [sudo] python setup_skytools.py install [--sk3-subdir]
 
 == Documentation ==
 
@@ -104,7 +114,7 @@ that simple anymore.
 But simple nonetheless: install PgQ on the machine where you want to
 run it, provider being the straightforward choice. Then install
 londiste only on the box from where you want to launch the replication
-process, a good default begin the subscriber box this time.
+process, a good default being the subscriber box this time.
 
 You can then install londiste on provider from the subscriber box with
 the +londiste.py+ command line tool.
@@ -112,4 +122,3 @@ the +londiste.py+ command line tool.
 == Usage ==
 
 Please refer to the documentation.
-
diff --git a/README b/README
index 6580117ce365f451885b2e0529d3bcb093cfcafb..ab9151d192dc26532cf86b8564bd01373386d326 100644 (file)
--- a/README
+++ b/README
@@ -11,7 +11,7 @@ It contains the following modules:
 
 === PgQ ===
 
-PgQ is a queuing system written in PL/pgsql, Python and C code. It is
+PgQ is a queuing system written in PL/pgSQL, Python and C code. It is
 based on snapshot-based event handling ideas from Slony-I, and is
 written for general usage.
 
@@ -53,8 +53,7 @@ Replication tool written in Python, using PgQ as event transport.
 Features:
 
 - Tables can be added one-by-one into set.
-- Initial COPY for one table does not block event replay for other
-  tables.
+- Initial COPY for one table does not block event replay for other tables.
 - Can compare tables on both sides.
 
 Documentation:
@@ -62,7 +61,7 @@ Documentation:
 - Londiste script usage: doc/londiste3.txt
   (also available as `man 1 londiste`)
 
-- Londiste HOWTOS: doc/howto/
+- Londiste HOWTOs: doc/howto/
 
 === walmgr ===
 
@@ -76,8 +75,7 @@ database server.
 == Source tree contents ==
 
 doc/::
-    Documentation in asciidoc format.  Source for both html
-    and man pages.
+    Documentation in AsciiDoc format.  Source for both html and man pages.
 
 python/::
     Python modules and primary executables - walmgr, londiste, qadmin, pgqadm.
@@ -108,7 +106,7 @@ sql/londiste/::
 
 sql/ticker/::
     PgQ ticker written in C.
+
 scripts/::
     Python scripts with lesser priority.
 
@@ -117,7 +115,7 @@ lib/::
 
 debian/::
     Debian packaging.  This is for creating private packages,
-    official Debian packages uses it's own packagin code.
+    official Debian packages use their own packaging code.
 
 misc/::
     Random scripts used for building.
@@ -135,4 +133,4 @@ Londiste 3 in parallel with Londiste 2.
 5. Apply londiste.sql - this will throw error on CREATE SCHEMA, but should otherwise apply fine.
 6. Start pgqd.
 
-The files mentined above are installed under $PREFIX/share/skytools3/ directory.
+The files mentioned above are installed under $PREFIX/share/skytools3/ directory.