/* readme.txt v0.80 */
/* Edward Boone */
/* epsilonbeta@geocities.com */
/* http://www.geocities.com/SiliconValley/Vista/6617/index.html */
/* Only nothing seems to be what it looks like */
-----------------------------------------------------------------------------
                        M I C H E L L E v0.80
-----------------------------------------------------------------------------

#include <std_disclaimer.h>
I'M NOT RESPONSIBLE IF SOMETHING GOES WRONG
(see thanks.txt for a list of the contributors :-))
(if something goes good, I'm responsible :-))

Michelle comes from "my shell", and is in fact yet another DOS-shell
environment that will save you a lot of time (+1).

Installation :
There are two kinds of distribution (with xx being the version)
a binary only distribution ebmchxxb.zip and
a source only distribution ebmchxxs.zip
After downloading, copy these files (or one of them) to c:\djgpp
then you can unpack them with
c:\djgpp\>pkunzip -d ebmchxxx.zip
This will create all necessary directories and will install michelle under
c:\djgpp\contrib\mich
Remark that the configuration file M U S T reside in c:\djgpp\contrib\mich !!!

Package contains:
c:\djgpp\contrib\mich\>
doc.txt                         reference document for see.exe
file_id.diz			short description of the package
help.txt                        how you can help
mi.exe				main executable
michbeta.txt                    configuration file
readme.txt                      the file you are reading now
thanks.txt			a list of the contributors
c:\djgpp\contrib\mich\source\>  C-sources
				required to compile
				mi.exe: DJGPP 2.0
				see.exe: DJGPP 2.0, LIBALLEG 3.0, LIBJPEG 1.3
				hear.exe: DJGPP 2.0, LIBALLEG 3.0, LIBJGMOD 0.72
				make
c:\djgpp\contrib\mich\util\>
hear.exe			listen to sound-files
                                (hear <file>)
				.MID, .MOD, .S3M, .VOC, .WAV, .XM
                                extract samples from sound-files
                                (hear <file> -extract)
                                .MOD, .S3M, .XM
see.exe				see picture-files or animation-files
                                (see <file>)
				.BMP, .GIF, .JPG, .LBM, .PCX, .TGA, .FLI, .FLC
                                and apply some very nice screen-FX
a few example .BAT files for batch processing (mi.exe)
.map color palettes used for applying screen-FX (see.exe)
.lst lists of .map files for fading (see.exe)

c:\djgpp\contrib\mich\data\>	directory reserved for collecting data

It is highly configurable (+2) and supports multiple users (+3).
Each time the program starts it will ask for your login name of 4 characters.
If you don't like this, you can skip the login-procedure
by setting the environment variable mi_login in your autoexec.bat
Then it will create a file mich.....txt in c:\djgpp\contrib\mich with
.... being your login name. If you're a new user the program will copy the
contents of michbeta.txt to mich.....txt to have a starting point.
All you have to do from then on is to edit your mich.....txt file to your
needs :

[section cfr keypressed]
extension of file where you're on
command-line

It's freeware (+4), and the source (C, DJGPP 2.0) is included (+5)
in the package.
In this case : freeware means you can do with it what you want, except
selling it. (If you will include this on a shareware/freeware CD-ROM,
feel free to do so, just e-mail me the title of the CD-ROM so I can
buy it :-))

If you want to help (read help.txt), if you have any
remarks/suggestions/improvements or you just want to say hello,
you can contact me at

epsilonbeta@geocities.com

----------------------------------------------------------------------------
			    MICHELLE KEYS
----------------------------------------------------------------------------

<h> or <F1> : help, shows this file

<Esc> : quit

<Page Up>, <Page Down>, <Cursor-keys>, <Home>, <End> :
	navigation keys (try out and you'll see)
<CR> : execute, see <CR>, <CR><Default> in mich....txt

<e> : edit, see <Edit>, <Edit><Default> in mich.....txt
<Alt-m> : make, see <Make>, <Make><Default> in mich.....txt
<p> : play, see <Play>, <Play><Default> in mich.....txt
<v> : view, see <View>, <View><Default> in mich.....txt

<s> : shell, runs a DOS-command

<c> : copy file
<d> : delete file
<m> : move file
<r> : rename file

<Space> : toggle selection
<Ctrl-k> : copy selected files
<Ctrl-d> : delete selected files
<Ctrl-o> : move selected files

<Alt-d> : change drive

<i> : interesting file, writes filename in c:\djgpp\contrib\mich\util\intr.....txt

<F2> :	batch-processing
	If you're on a special for the purpose written .BAT-file (see under
	c:\djgpp\contrib\mich\util for examples) and you press F2,
        the .BAT-file will be executed for all the files in a to specify
        textfile.
	You can choose between manual (press any key to continue) and auto
        mode by setting batch_mode to manual or auto in the [Other]-section in
	c:\djgpp\contrib\mich\mich.....txt

<F3> :  Un"zip" all "zip"files in current directory by creating first a subdir
	and moving the "zip"-file to that subdir before un"zip"ing
	A zip-file is recognized by it's extension
	(.arc, .arj, .gz, .lzh, .rar, .tar, .tgz, .zip).
	You will need the separate (un)packers for this to work and they must
        be in your PATH.
	They're all share or freeware and easy to find (on CD-roms,
	Internet, BBS's).

<F4> :  deletes c:\djgpp\contrib\mich\util\intr.....txt

<F5> :  get it
        scans directories and subdirectories for filenames with a given
        extension and puts their filenames in a txt-file which can futher
        be processed with <F2> batch-processing

<F6> :  get all
        scans directories and subdirectories for multimedia files and copies
        them to c:\djgpp\contrib\mich\data
        Warning : be sure to have enough diskspace :-)
	Remark : not all filetypes are supported by michelle, see above for a
        list of the supported filetypes.

<F7> :  extract samples
        scans directories and subdirectories for .MOD/.S3M/.XM-files,
        extracts the samples and saves them as .WAV-files (SR : 16574Hz (middle C)) in
        c:\djgpp\contrib\mich\data
        Warning : be sure to have enough diskspace :-)

<w> : version information + who made it

----------------------------------------------------------------------------
			      HEAR KEYS
----------------------------------------------------------------------------

Go within michelle with the cursor keys to a sound file and press <Enter> ...
Then you can start using these keys depending on the format of the sound file.
See at the top of this file for supported formats.

<Esc> : quit

.MOD, .S3M, .XM : <+> : goto next pattern
                  <-> : goto previous pattern

.VOC, .WAV : <up>       : raise pitch
             <down>     : lower pitch
             <left>     : pan left
             <right>    : pan right
	     <insert>   : 2/3 original frequency (slower)
             <home>     : original frequency
             <pageup>   : 4/3 original frequency (faster)
             <delete>   : left speaker only
             <end>      : both speakers
             <pagedown> : right speaker only

----------------------------------------------------------------------------
			       SEE KEYS
----------------------------------------------------------------------------

Go within michelle with the cursor keys to a picture file and press <Enter> ...
Then you can start using these keys.
See at the top of this file for supported formats.
The effects have been tested and are designed for 320x200 picture files with 256 colors.
They may or may not work with other kind of pictures.
The effects are not applicable for .FLI or .FLC

<Esc> : quit

<F1-F12> : select main effect (see mich.....txt for futher details)
<0-9> : select sub effect
Warning : some effects may have weired effects on elleptic people :-)

<Insert> : restore image
<Home> : restore palette
<Page Up> : restore image + palette

<End> : save current palette in a .map-file (range 0..255) in c:\djgpp\contrib\mich\data
<Page Down> : save current screen in a .pcx-file (320x200, 256) in c:\djgpp\contrib\mich\data

<i> : interesting file, writes filename in c:\djgpp\contrib\mich\util\intr.....txt

----------------------------------------------------------------------------
			    TIPS 'N TRICKS
----------------------------------------------------------------------------

* Copy mi.exe to c:\djgpp\bin and put this directory in your path (autoexec.bat)
if it isn't allready.
This way you can access michelle from every directory.

Enjoy !!! :-)))
