File	Date	Author	Commit
Kemuri.app	2010-10-02	Boris ARZUR	[043645] Cosmetics
files	2012-02-02	k4ppa	[5f2312] added favicon
screenshots	2010-08-24	Boris ARZUR	[5ffd8b] bad screenshots
CHANGELOG	2011-08-23	ARZUR	[f46680] changelog is more or less up to date...
COPYING	2010-08-13	Boris ARZUR	[7ef99c] final preparations for release
README	2011-08-23	ARZUR	[4a71b3] updated blabla for release
backstore_handling.rb	2011-04-29	Boris	[28ebc2] cosme & reorg
bar.css	2012-02-02	k4ppa	[d6dc4c] element positioning.
biskip.sv.rb	2011-04-27	Boris	[9f687c] fix utf8 pb
capture.js	2010-10-07	Boris ARZUR	[2b8117] tentative work on capture
dbs.rb	2011-04-27	Boris	[9f687c] fix utf8 pb
engine.rb	2012-02-02	k4ppa	[5f2312] added favicon
exit.sv.rb	2011-04-27	Boris	[9f687c] fix utf8 pb
files.sv.rb	2011-12-18	Boris ARZUR	[c4c651] Files enchancements
glisse.css	2012-02-02	k4ppa	[f33135] glisse -> move initial position
glisse.js	2012-02-02	k4ppa	[acb916] relative positions adjustements
his.sv.rb	2011-04-27	Boris	[9f687c] fix utf8 pb
index.html	2011-09-01	ARZUR	[e6829d] cosme in index.html
iphone.db	2010-08-30	Boris ARZUR	[06f388] corrected bug in regexp
iphone.sql	2010-08-30	Boris ARZUR	[1c78d1] index on strokes
json.rb	2011-08-23	ARZUR	[1109a9] JSON rewrite for AJAX calls. Nice speedups for ...
kan.sv.rb	2011-04-27	Boris	[9f687c] fix utf8 pb
kanji_table.html	2011-05-14	Boris	[0ac200] "look" module is in debug. searching is goood. ...
kanji_table.rb	2011-05-30	Boris	[44c448] use radi strokes to sort... finally.
kemuri.rb	2012-02-01	k4ppa	[814f04] gz compression
lists.sv.rb	2011-04-29	Boris	[1f6457] minor cleanups
log.sv.rb	2011-04-27	Boris	[9f687c] fix utf8 pb
look.sv.rb	2012-02-02	k4ppa	[c30983] forgot a little detail in cleaning look
mime_types.rb	2011-07-20	Boris ARZUR	[b64536] ability to serve static files
next_page.js	2011-08-23	ARZUR	[bdab71] Sneaky sneaky bug...
pos.sv.rb	2011-04-27	Boris	[9f687c] fix utf8 pb
proxy.sv.rb	2011-05-29	Boris	[60d98e] good proxy, supports redirs
quatrecentquatre.sv.rb	2011-05-29	Boris	[62bca4] removed the message, so that the Proxy module w...
rad.sv.rb	2011-05-30	Boris	[44c448] use radi strokes to sort... finally.
rad_bar.js	2012-02-02	k4ppa	[acb916] relative positions adjustements
search.js	2012-02-02	k4ppa	[acb916] relative positions adjustements
server.rb	2012-02-02	k4ppa	[e8ef21] fixed multipart post requests from androids
sk.sv.rb	2011-04-29	Boris	[1f6457] minor cleanups
slook.sv.rb	2011-05-29	Boris	[34004c] added fuzzy skips in look
static.rb	2012-02-02	k4ppa	[d6dc4c] element positioning.
voyage.css	2010-10-03	Boris ARZUR	[a3d06f] Minor adjustements on the voyage bar
voyage.js	2011-05-29	Boris	[45fcef] stupid error corrected
yad.sv.rb	2011-08-23	ARZUR	[1109a9] JSON rewrite for AJAX calls. Nice speedups for ...
yad_bar.js	2012-02-02	k4ppa	[acb916] relative positions adjustements
yav.sv.rb	2011-04-27	Boris	[9f687c] fix utf8 pb

Read Me

 ** Description **

   == Japanese dictionary & flashcards like software for jailbroken
   == iphone/ipad/ipod touch.

This software only works on _jailbroken_ igadgets, since it needs ruby
& sqlite3 bindings for said language. It also works on standard hardware
as long as the scripting langage is available.

It's based on the KANJIDIC and KRADFILE projects, more
specifically on their xml versions and includes a sql version of these
projects, feel free to reuse them.
See http://www.csse.monash.edu.au/~jwb/kradinf.html for Kradfile and
http://www.csse.monash.edu.au/~jwb/kanjidic_doc.html for Kanjidic.

It creates a web server on 127.0.0.1:8185 that you can access with
safari and query for skip codes/kanjis/prononciations/translations of
english words, it also features jlpt's lists, and your own if you
spend some time building them.

I provide sqlite3 ruby bindings as a gzipped tarball (see
kemuri.sf.net) of the build tree, it's a not so old, not so recent
version, by all means please use the lastest one you may find at
sqlite-ruby's project page (http://rubyforge.org/projects/sqlite-ruby).

 ** License **

See file COPYING for license information.

The dictionary files (iphone.db and its source iphone.sql) are on a
different Copyright regime :

  KANJIDIC, KANJD212 and KANJIDIC2 can be freely used provided
  satisfactory acknowledgement is made in any software product,
  server, etc. that uses them. There are a few other conditions
  relating to distributing copies of the files with or without
  modification. Copyright is vested in the EDRG (Electronic Dictionary
  Research Group, see http://www.edrdg.org/). You can see the specific
  licence statement at the Group's site :
  http://www.edrdg.org/edrdg/licence.html.

  The files are available from the Monash University ftp site
  http://ftp.monash.edu.au/pub/nihongo/kanjidic.gz and
  http://ftp.monash.edu.au/pub/nihongo/kanjd212.gz.

  The RADKFILE and KRADFILE files are copright and available under the
  EDRDG Licence. The copyright of the RADKFILE2 and KRADFILE2 files is
  held by Jim Rose.

 ** Installation & Usage **

Upload all directory 'as-is' to your igadget & run 'ruby kemuri.rb' in
it, it will need to stay running so it might be more convienent to
execute 'ruby kemuri.rb & disown'.

*edit 2010/10/07*
You don't have to do that for versions >= 1.2, there is an app folder
you can move in your /Applications, creating a SpringBoard icon, that
does the work for you.

In idevice's safari, go to
http://127.0.0.1:8185/{amodule}/{whatever}?{options&}capture
(e.g. /yad/start?capture ) and touch '+', 'add on home screen', to
create a web-app.
*end edit*

Direct your browser to one of the sub-module :
  - http://127.0.0.1:8185/yad for the dictionary;
  - http://127.0.0.1:8185/yav for the flashcards;
  - http://127.0.0.1:8185/kan for Kanji info;
  - http://127.0.0.1:8185/skip for skip codes, stroke count based searches;
  - http://127.0.0.1:8185/rad for radical based search.

These modules are as RESTful as possible :
  - /yad/start looks for start in the dictionary;
  - /kan/漢 looks for 漢 in the database;
  - /skip/1-2-3 tries to match 1-2-3.

Basically each .sv.rb induced servlet is available through
http://127.0.0.1:8185/`basename ${file} .sv.rb`.

On most modules, you will find a 'smart' input box, you can push
text (we call it $1 in what follows) in it, it will try to redirect you :
  - 'rad' and 'his' go to the modules /rad & /his;
  - *-*-* (more specifically /^\d-\d+-\d+$/ ) and /^\d+$/ to /sk/$1;
  - /^\d-\d+-\d++\d-\d+-\d+$/ to /biskip/$1 (bruteforce a pair of 
    skip-codes, a bit slow);
  - /^\d-\d+-\d+-\d-\d+-\d+$/ to /sk/$1;
  - numbers and hyphen separated pairs of numbers go to /sk/$1;
  - single kanjis to /kan/$1 or /yad/$1 (you have to choose);
  - multiple kanjis or kana to /yad/$1.
  - expression containing & or + to /slook/$1, then to
    /look/a_random_string, see the **Search** section.

This is the prefered way of interacting with Kemuri.

In some modules, you will find a blue button, try to drag it, it can be used
to navigate and will show in its center where it is going to send you.

In some modules, you will find a blue button, try to drag it, it can be used
to navigate and will show in its center where it is going to send you
For example, in /yav, it is used to answer : 'y' is 'yes, I know the kanji',
'n' is 'no', 'h' is 'hibernate' and 'yy' is 'double yes'. Different answers
have different effects on the learning algorithm, please refer to the code.

Please note this software uses ruby, sqlite3 and sqlite3-ruby, you
might need to get that installed before you can use Kemuri.

 ** Search **

This program features a new way of searching for kanjis : combine radicals
from whatever kanji you know, with vague skip codes (such as "it's a two part
vertical kanji" or "there's 4 strokes on the top part") and stroke counts, glue
these descriptions together with '&', add the possibility to look for more than
one kanji at a time with '+' and you have the ultimate kanji searching application.

Examples :
  - typing 帯&1-3-_+在 in voyage, when you are looking for 滞在;
  - 特+残&1-_-_+医+病&小+研+究 for 特殊医療研究...

 ** Author **

Brought to you by boris <d0t/> arzur <4t/> gmail.