From b33433f0ef359e705e41d799db760d3d54144142 Mon Sep 17 00:00:00 2001
From: Peng Wu <alexepico@gmail.com>
Date: Tue, 12 Jul 2011 15:36:15 +0800
Subject: write file format

---
 docs/fileformat | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 docs/fileformat

(limited to 'docs')

diff --git a/docs/fileformat b/docs/fileformat
new file mode 100644
index 0000000..d0945b9
--- /dev/null
+++ b/docs/fileformat
@@ -0,0 +1,9 @@
+The file format of libpinyin
+
+Input file format
+1. Index Files
+   * raw corpus are classified into /index/<category>/<subsection>/<items>.index
+     * Every line consists of <item>#<item path name>
+2. Content Files
+   * The content file is stored in <item path name>, such as <number>.text.
+     * Note: please add a prefix to the <item path name>, so the content files are easier to organize.
-- 
cgit