Read Me
[About]
App Name: Wasuramoti
App Version: 0.6.3
Developer: Haruhiro Yoshimoto <pjmtdw@gmail.com>
Required OS: Android OS version >= 2.1
Description: Hyakunin-Isshu audio player specialized for training Kyogi-Karuta (Competitive Karuta).
`Hyakunin-Isshu' is a set of classic Japanese poetry, and `Kyogi-Karuta' is a Japanese sport which uses the set.
Note: The packaged wasuramoti-*.apk is compiled in Android NDK which is targetted to ARM,ARM-v7a,x86 CPU.
Therefore the wasuramoti-*.apk only works on those CPU's.
[License]
Wasuramoti is an open source software, which is licensed under BSD 3-Clause License.
You can download the source code from http://sourceforge.net/projects/wasuramoti-andr/
The licence is written in COPYING file which is placed on the same directory of this README.
However, note that the audio file enclosed in the *.apk package might have another licence.
Therefore, redistributing the *.apk file might have some limits.
I will write the copyrights and licence of the audio file in below when packaging *.apk.
__WRITE_AUDIO_LICENCE_HERE__
[Credits]
This software uses the following library which is copyrighted as follows:
- <libogg/libvorbis> Ogg Vorbis is Copyright (c) 2002-2008 Xiph.org Foundation
[How to Install]
Copy wasuramoti-*.apk to SD Card or run Android machine in USB Storage mode and copy to it.
Run 'ES File Explorer' (or some other file explorer) and browse to the copied file.
Click wasuramoti-*.apk and the installation will be started.
Note that you have to allow installation from `Unknown sources'.
Additionally, you can install by running a command `adb install wasuramoti-*.apk'.
Browse following URL for further information:
http://developer.android.com/guide/developing/device.html#setting-up
[Where to put .ogg file in the external storage such as SD Card]
Make directory named `wasuramoti_reader' and make subdirectory named `inaba' or whatever.
Then put the .ogg files in it.
Ogg files must be named in format of <name>_%03d_%d.ogg when the directory name is `<name>'.
First %03d indicates fuda number (refer to AllFuda.scala).
The second %d indicates 1 for Kami-no-Ku(upper phrase), and 2 for Shimo-no-Ku(lower phrase).
For example the Simo-no-Ku of 7th fuda which is read by `inaba' must be placed in:
`wasuramoti_reader/inaba/inaba_007_2.ogg'
The <name>_000_1.ogg is optional. Because sometimes Kami-no-Ku of Joka might be concatenated in <name>_000_2.ogg.
[Where to put .ogg file inside the application]
The naming convension of the *.ogg file of the reader is as follows:
src/main/assets/reader/<name>/<name>_000_1.ogg (optional)
src/main/assets/reader/<name>/<name>_000_2.ogg (lower phrase of Joka)
src/main/assets/reader/<name>/<name>_001_1.ogg (upper phase of Akinotano)
src/main/assets/reader/<name>/<name>_001_2.ogg (lower phase of Akinotano)
src/main/assets/reader/<name>/<name>_002_1.ogg (upper phase of Harusugite)
...
src/main/assets/reader/<name>/<name>_100_2.ogg (lower phase of Momoshikiya)
However, scripts/make_package.sh makes symbolic link from `${READER_DIR}/<name>' to `src/main/assets/reader/<name>',
and builds *.apk package. Therfore you should use this script to make *.apk file.
[How to compile]
Requirements:
openjdk6 (or some other Java JDK)
scala 2.9.1
sbt 0.11 (A Scala-Based Simple Build Tool)
sbt-android-plugin 0.6.x
android-sdk r16
android-sdk-platform-tools r10
android-platform-15
android-ndk r7
Before executing the following command, you have to execute `cd src/main/jni/libogg-*/ && ./configure && make`
Just compile:
$ sbt compile
Make a *.apk package for debug:
$ sbt android:package-debug
Run in device:
$ sbt android:start-device
Make a *.apk package for release:
$ sbt android:package-release
Haruhiro Yoshimoto