--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Fri Aug 28 21:06:50 2009 +0200
@@ -0,0 +1,59 @@
+
+OPENSOLARIS.ORG G11N LOCALE WORKSPACE
+=====================================
+
+This file contains the structure and the instructions for downloading and
+building the G11n Locale workspace for OpenSolaris.
+
+
+Description of the Workspace
+----------------------------
+
+The workspace is part of Common G11n Workspace (CWS). Together with other parts it 
+allows to build all OpenSolaris.org G11n packages. See build instructions at
+  http://XXX
+
+The workspace allow to compile OpenSolaris locale data objects (locales) based
+on CLDR data.  This workspace does not contain the upstream sources and tools,
+the sources are downloaed during the build process so you need internet access
+to build this workspace.
+
+
+Structure of the Workspace
+--------------------------
+
+./Makefile		master makefile
+./config.mk		build configuration
+./downloads/		all data downloaded from internet, 
+			'make clean' does not clean this dir
+./jars/			all jars necessary to build the locale data,
+			some of the jars are builded from upstream
+./locale/*.spec	locale spec files (see 'Locale Spec File Structure' section)
+./locale/charmap/	charmap files are generated there
+./locale/src/		posix src files are generated there
+./misc/			misc files for locale object generation
+./misc/patches/		patches of upstream code
+./misc/patches/cldr_core/	patches of CLDR locale data, 
+			fix known bugs or add solaris specific code
+./misc/patches/cldr_tools/	patches of CLDR tools, 
+			fix known bugs and add solaris specific code
+./tools			tools used for build
+
+
+Locale Spec File Structure
+--------------------------
+
+If you need add a new locale, usually all you need is to createa locale spec file to locale/<locale name>.spec
+
+Format of the file is 
+
+	# comments ...
+	<key>TAB+<data>
+
+
+Keys:
+	cldr_variant	cldr locale variant, see XXX for description	(*)
+	pkg_name	pkg name for the locale				(*)
+
+
+* mandatory keys