**************************************************************************
***                   Readme file for Sunshine Commander               ***
**************************************************************************

Content
-------

  1. Introduction
  2. Installation
  3. Usage
  4. Developers
  

1. Introduction
---------------
  Sunshine Commander is an attempt to make a consolebased, crossplatform,
filemanager, which allows the user to do common filecentred tasks within a 
single program, including full linux-filesystem support, archivehandling, 
FTP-handling etc.
  The obvious question is, what's wrong with Midnight Commander? Nothing, 
of course, other than I never felt quite at home here, and then thought I 
better give it a shot at writing another to suite my purposes. And I hope 
some of the features (which I think are somewhat nicer than MC's) will make 
it interesting for other, as well.
  Well, it isn't actually featurecomplete yet, but I hope you will give it 
a shot anyway. Please do not hesitate to contact me with any comments, 
ideas or opinions about beer. If you would like to help with development 
or other tasks it would be very wellcome, too.

  Yours Sincerely
  Morten Poulsen, author of Sunshine Commander
  sc@poulsen.org
  
  **************
  * Disclaimer *
  **************
  I try to test all features in this program as much as I can find the time 
  to, but unfortunately this does not completely eliminate the possibility 
  of some degree of malfunction, even fatal error. I will hold no responsi-
  bility whatsoever over any loss of data, malfunction of hardware or other 
  software. Please keep backups of all important data to avoid catastrophes.
  
2. Installation
---------------
LINUX:
  Requirements:
    - A working (n)curses, I don't think the version is that important, 
      but please report problems!
    - A working zlib

  Finally I got the autoconf-thing working, so it should be as simple as:
    ./configure
    make
    make install (as root)
  For further instructions, please see the file called INSTALL
  As KDevelop is partly used as IDE a projectfile for this is included, 
  as well.

  If you want to be able to end up in the last directory you accessed 
  within SC, when you exit it, you should add the following to your 
  .bash_profile file:
    sc ()
      {
        SCO=~/.scoutdir
        rm -f "$SCO"
        /usr/bin/sc
        cd "`cat $SCO`"
        rm -f "$SCO"
      }

   And you should of course enable the function in the configuration file. 
   I only know how to do this with bash. If you succeed in making it work 
   with other shells, please inform me and I will include the information 
   in this file.

DOS:
  Requirements:
    - A working zlib
    
  You have two choices:
    1. Use RHIDE (a freeware IDE for DJGPP), you can find it here:
         http://www.tu-chemnitz.de/~sho/rho/rhide-1.4/rhide.html
       Projectfiles are included with this distribution, just change to the
       directory [sc] and execute RHIDE. Type F9 to compile and link...
    
    2. Try to change to the source directory with 'cd sc' and execute the
       command 'make -f sc.mak' and cross your fingers... It may or may not 
       work.


3. Usage
--------
  Well, I don't have the time to write a complete referencemanual, but here
are come general guidelines:
    - Always refer to the onlinehelp (which is almost complete) showed by
      pressing F1.
    - Do not hesitate to contact me with any questions
    - If you find the lack of proper documentation too annoying, feel free 
      to write some (preferably in SGML-format) and I will include it in 
      the distribution.



4. Developers
-------------
  I must that the code is quite uncommented, but I try, slowly, to fix 
this. Of course, I believe that the code is more or less selfexplainatory, 
but I am supposed to as I have written it, right? ;-)
  If you are interested in helping with the development, contact me and 
I will write a description of how the program is designed. But as I am 
the only developer (the other one is presently without a computer), the 
need is not there yet.
  I hope this does not keeps you from implementing a lot of great features,
and I promise to be very helpful should you decide to contribute to the 
project. 

  Have fun!  
  Morten Poulsen

