PSPComic version 0.9.5 Beta
A Comic Book Reader for the PSP!
Copyright (C) 2007 Jeffrey P. (AKA Archaemic) & Christophe Rudyj (AKA Kip)
========================================
Table of Contents
I.	Usage
     a. Installing
     b. Adding comic books
     c. Controls
     d. Menu options
II.	Compiling from source
III.	Notes
IV.	Frequently Asked Questions
V.	History
VI.	Legal
VII.	Credits
========================================
I.	Usage
========================================
     a. Installing
----------------------------------------

To install this program, you must have one of several firmwares running on your
PSP:
	- 1.50
	- 2.71 SE
	- 3.02 OE
	- 3.03 OE
	- 3.10 OE
	- 3.30 OE
	- 3.40 OE
Or any other firmware that can emulate firmware 1.50 through DevHook (such as
2.71 running Homebew Enabler (HEN)). To install this program, place the folders
pspcomic and pspcomic% in the MS_ROOT/PSP/GAME folder if you are running or
emulating firmware 1.50 or if you have your version of OE set to 1.50 kernel
mode, or in the MS_ROOT/PSP/GAME150 folder otherwise.

To run the program, go to the Game option in the top menu of the Cross Media Bar
(XMB), sroll down to the Memory Stick option, and select PSPComic from the menu
It should now run.

----------------------------------------
     b. Adding comic books
----------------------------------------

The process of adding comic books to the memory card is quite simple. Just put
the comics in the folder "comics" at the root of the memory stick. As of version
0.9 beta, subdirectoriesare not supported and will be ignored by the program.
The file must also not have a name longer than 200 characters, or else it will
also be ingnored by the program, due to the limitations of the UnRAR library.

----------------------------------------
     c. Controls
----------------------------------------
Context:  Comic book			Menu
D-Pad:	  Pan				Scroll
Triangle: Zoom in			Go back
Cross:	  Zoom out			Select
Circle:	  Rotate clockwise		No action
Square:	  Rotate counterclockwise	No action
Select:	  Fit page to width/full size	No action
Start:	  Open menu			Close menu
Left shoulder:	Previous page		No action
Right shoulder:	Next page		No action
----------------------------------------
     d. Menu options
----------------------------------------

- Open comic book...
	Open a menu to select which comic book to switch to
- Close comic book
	Close the current comic book and return to the top menu
- Next comic book
	Open the next comic book in the list
- Previous comic book
	Open the previous comic book in the list
- Jump to page...
	Select a page to which to jump
- Toggle resize method
	Switch method with with to resize the page. Options are nearest neighbor
	(default) which is blockier but faster, and simple resample, which is slower
	and blurrier, but often makes text slightly easier to read. Please note that
	the page you're currently on is not reprocessed, and the change doesn't take
	effect until you zoom, rotate or change the page. Only the nearest neighbor
	resize method works on 8-bit images, and as such, the program defaults to
	using this method for 8-bit images. It does not, however, change the setting.
- Adjust clock frequency
	Change the frequency of the clock. If it is higher, scrolling will be smoother
	and page operations such as resizing and rotating will be faster, however, more
	battery will be consumed. The default clock frequency of the PSP is 222 MHz.
	Speeds under this are not recommended because the program will slow down
	immensely, but will save battery.
- Quit
	Close the program
- Reload menu
	Reload list of books (for if your comics folder changes)
- < Go back
	Close the menu or return to a higher menu

========================================
IV.	Compiling from source
========================================

The source code can be compiled if you have zlib, SDL and SDL_image installed
for PSPSDK by going to the main folder of the source code, which should be
"src", and typing the following commands (excluding the $):

$ cd rar
$ make -f Makefile.psp
$ cp libpspunrar.a ..
$ cd ..
$ make -f Makefile.psp
$ cp *.png pspcomic

The source code may be compiled for Windows (and quite probably some POSIX
systems) using the Makefile.windows makefiles for Windows. The Makefile in the
main directory is for compiling the main program and the minizip library
segments, and the Makefile in the rar directory is for compiling UnRAR as a
library. This library must be then placed in the main directory for
Makefile.window to detect it. The main Makefile should be processed by MinGW
using mingw32-make or MSYS, and the UnRAR Makefile must be processed by MSYS.
Processing these files with Cygwin may work, but is untested. The non-PSP
version of the program is only for testing the software, and is not fully
functional. The menus do no display on the screen, and are instead outputted to
the file stdout.txt. You also need to obtain the DLLs (or SOs if you are on a
*nix system) and place them in the main folder. Alternatively, if the DLLs or
SOs are installed in global locations, the program can also be run; however,
this is not recommended, so as to avoid DLL Hell.

========================================
III.	Notes
========================================

- Please send all bug reports to the email address archaemic.spam at gmail.com.
  If this program crashes with a blue screen, please send the contents of the
  bottom line of the error message (i.e. psp-addr2line etc.), including the one
  letter below the last line, to the email address mentioned above. Please note
  that this program is extremely stable, and no crashes in the most recent build
  have been observed.
- The background is customizable. Simply replace the file background.png in the
  game's folder with another image (preferably 480x272, although it doesn't need
  to be), and it will be loaded as the background for the menu.
- Large pages, when made full size, may cause the PSP to run out of memory if
  attempting to rotate, or sometimes if just loaded. Make sure not to use very
  high resolution comic books with this program. If memory runs out, the page
  will "freeze", meaning it will no longer be able to be operated on, but you
  can still change pages in the comic book.
- If your file or folder is not shown in the file list, that means that the file
  is either of the wrong type, of that the filename is too long (over 250 bytes,
  including the name of the folder).
- DO NOT ATTEMPT PUT THE PSP INTO STANDBY MODE WHILE A PAGE IS LOADING! THIS MAY
  CAUSE THE PSP TO CRASH.
- This program is statically linked to SDL_image, which in turn is statically
  linked to Independant JPEG Group's (IJG) implementation for reading JPEGs.
- This program is statically linked to zlib and minizip.
- The version of UnRAR distributed with this source code is slightly modified so
  as to work with the PSP. It is not the original source code, although it may
  be able to be compiled in an identical manner to the original source code and
  would likely be able to be used in the stead of the original source code.
- This program, when run, will create two files, stdout.txt and stderr.txt.
  These files are not used by the program, and are created by SDL, with which
  this program is statically linked. These files may be removed at any time, but
  removal of these files is not recommended, as they will be recreated when the
  program is run next.
- The config file, while human-readable, should not be edited by a human. The
  parser is specific about the syntax, and is not very robust. The file must end
  with a whitespace character.

========================================
IV.	Frequently Asked Questions
========================================

Q. When I try to load up some pages in a comic book, I get a notice saying
   "SDL_image: JPEG loading error". What does this mean and can I fix it?
A. This usually means that the PSP ran out of memory when trying to load the
   JPEG in the comic book archive. This cannot be fixed. Try using a lower
   resolution version of the same comic book.

========================================
V.	History
========================================

v0.9 Beta (2007-04-16)
- Initial release

v0.9.5 Beta (2007-04-27)
- [Feature] Subdirectory support added
- [Feature] Added optional zoom level or rotation persistence between pages
- [Feature] Adjustable pan rate
- [Feature] Select button now switches between fit to width and full size.
- Ability to save/load configuration
- [Bugfix] Resample algorithms now work as selected, and no more garbling for 8-
  bit images.
- [Bugfix] Next/previous comic book menu option now works even if comics on the
  memory stick are changed while menu is open.
- [Bugfix] Fixed crash bug when resizing a full-sized page to fit to width.
- And many more minor changes...

========================================
VI.	Legal
========================================

This program is copyrighted (C) by Jeffrey P. and Christophe Rudyj. Portions of
this program are licensed under the terms of the GNU General Public License
(GPL), and other portions under the terms of both the UnRAR license and the GPL,
as specified later in this section. The source code distribution of this program
includes two libraries, a portion of the minizip library, which is licensed
under the terms of the zlib license, and a modified version of the UnRAR
library, which is licensed under the terms of the UnRAR license. For the GPL,
please read the file license.txt. For the UnRAR license, please read the file
src/rar/license.txt. For the zlib license, please refer to
http://www.zlib.net/zlib_license.html.

The files in the main folder and the src folder are licensed under the GPL
exclusively, including the images, which are counted as source code, and
excluding the file rar.hpp and the file rar.cpp. The files in the src/rar folder
and the files rar.cpp and rar.hpp in the main folder are licensed under the
UnRAR license exclusively. The files in the src/zip folder are a portion of the
minizip library by Gilles Vollant and are licensed under the zlib license
exclusively. In addition, as a special exception, Jeffrey P. gives permission to
link the code of this program with the UnRAR and minizip libraries and the files
rar.cpp and rar.hpp (or with modified versions of UnRAR, minizip, rar.cpp and
rar.hpp that use the same license as UnRAR, minizip, rar.cpp and rar.hpp,
respectively), and distribute linked combinations including the four. You must
obey the GNU General Public License in all respects for all of the code used
other than UnRAR, minizip, rar.cpp and rar.hpp. If you modify the program, you
may extend this exception to your version of the file, but you are not obligated
to do so. If you do not wish to do so, delete this exception statement from your
version.

This means that the user is free to redistribute and/or modify the program
under the terms of the GPL, so long as the user freely provides any
modifications to the source code and uses this same license upon redistribution
and does not use the source code to create an implementation of the RAR
compression algorithm.

THIS PROGRAM, AS IT IS FREE SOFTWARE, IS NOT COVERED BY A WARRANTY TO THE EXTENT
PERMITTED BY LAW. IT IS PROVIDED IN AN 'AS-IS' CONDITION, AND THE PSPCOMIC
PROJECT IS NOT RESPONSIBLE FOR ANY DAMAGES OR DATA LOSS THAT MAY OCCUR, HOWEVER
UNLIKELY IT IS FOR ANY DAMAGES OR DATA LOSS TO OCCUR.

========================================
VII.	Credits
========================================

All of the programming and the PSPComic icons were done by Jeffrey P. Main
background, ideas and encouragement were graciously provided by Christophe
Rudyj. Testing was done by Jeffrey P., Christophe Rudyj and "Chirishman". Some
help was obtained from the Comical project (http://comical.sourceforge.net/) in
the writing of the RAR reading code. Comical is a good free software comic book
reader for Windows, Mac or Linux (and possibly other POSIX operating systems) if
you are looking for a program with which to view comic books on the computer.
The font used in the graphics is Komica, which can be found at
http://www.dafont.com/komika-poster.font