wrdk/doc/QuickStart

Quick start instructions
========================

This is only rough at the moment, need to expand it somewhat

To obtain a list of targets use the command:
  make help


A. Compiling WikiReader program and QT4 simulator
=================================================

1) make sure samo-lib/include/config.h is setup
   copy from samo-lib/include/config.h-default

   The make files will do the copy, but the
   BOARD_SAMO_V1 must be uncommented by manual editing

2) make clean

   There maybe errors because of missing programs, these will be
   indicated by an apt-get install message to show the Ubuntu 9.10
   package(s) to install.

3) make


B. Compiling a test database (single language version for an old kernel.elf)
============================

** This section is now deprecated **

   Requires Python2.6 ocaml PHP5 LaTeX and dvipng

1) mkdir -p image work

   make DESTDIR=image WORKDIR=work \
     XML_FILES="XML-Licenses/en/license.xml XML-Licenses/en/terms.xml xml-file-samples/japanese_architects.xml" iprch

   #Note: iprch => index parse render combine hash

2) Optionally: simulate using qt4-simulator:
   make DESTDIR=image fonts-install sim4

3) make DESTDIR=image install

4) Format a microSD card as FAT32 and copy the contents on image to it
   e.g.   mkfs.vfat -F 32 -n wikird /dev/sd<id-and-partition>
          mount /dev/sd<id-and-partition> /mnt
          cp image/* /mnt/


C. Compiling a test database (multiple language version - latest kernel.elf)
============================

1) mkdir -p image work

   make DESTDIR=image WORKDIR=work WIKI_LANGUAGE=en \
      XML_FILES="XML-Licenses/en/license.xml XML-Licenses/en/terms.xml xml-file-samples/japanese_architects.xml" \
      cleandirs createdirs iprc

   #Note: iprch => index parse render combine

2) Optionally: simulate using qt4-simulator:
   make DESTDIR=image fonts-install nls-install sim4

4) Install fonts and programs
   make DESTDIR=image install

5) format a microSD card as FAT32 and copy the contents on image to it
   e.g.   mkfs.vfat -F 32 -n wikird /dev/sd<id-and-partition>
          mount /dev/sd<id-and-partition> /mnt
          cp -r image/* /mnt/