X-Git-Url: https://git.korewanetadesu.com/?p=python-collate.git;a=blobdiff_plain;f=README.txt;h=eeb68b019061703f927a3921d917880ccb2b30d1;hp=35bef84156582d636b7c87ac96c4da40a956caa2;hb=b278dcabc282c5faa070a72c2e7fd915597ccd00;hpb=08e8f0a8bb8d7276d114087f8ff8dbce4acdb1cf

diff --git a/README.txt b/README.txt
index 35bef84..eeb68b0 100644
--- a/README.txt
+++ b/README.txt
@@ -1,42 +1,3 @@
-This module is unsuitable for real-world use at this time.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 pycollate - Collation algorithms for Python
 -------------------------------------------
 
@@ -47,26 +8,31 @@ Supported backends:
 - syslocale - Native OS collation routines.
 - codepoint - Raw Unicode codepoint comparison
 
-The different backends have varying features and behaviors; which one
-is best depends on your goals. A specific backend can be used, or a
-"best" backend is chosen by default.
+If available, you'll probably want to use the ICU backend. If it's not
+available, syslocale should work on most Python installations. A
+specific backend can be used, or a "best" backend is chosen by
+default.
 
 pycollate also provides tools to perform word-wise and numeric sorts.
 
 pycollate, as with all Unicode collation tools, is a work in progress.
 
+Installing
+----------
+$ sudo apt-get install python-pyrex libicu-dev
+$ ./setup.py build
+$ sudo ./setup.py install
+
 Example
 -------
 import collate
-strings = file("contents.txt").read().decode("utf-8").splitlines()
+strings = open("contents.txt").read().decode("utf-8").splitlines()
 strings.sort(key=collate.key)
-# Equivalently but slower,
-strings.sort(cmp=collate.cmp)
 
 License
 -------
 
-icu/_ucol.pyx:
+icu/_icu.pyx:
 
 Copyright (c) 2004 Zope Corporation and Contributors.
 All Rights Reserved.