Read Me

Copyright 2009, 2010 Lane Christiansen, Brandon Test

LICENSING INFORMATION:

  This file is part of Milo.

  Milo is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  Milo is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with Milo (filename: LICENSE.txt).  If not, see
  <http://www.gnu.org/licenses/>. 

  A list of all files to which this license applies, along with their SHA-1
  checksums can be found in the file "FILES.txt", in the current directory.
  Although src/book.ico and the contents of src/images/crystal/ are part of
  this list, they are NOT the original work of Milo's authors, and are subject
  to their own license. See src/images/crystal/README for more information.
  The contents of src/isbndb/ were written by one of Milo's authors several
  months before work began on this project. They were licensed separately.
  See src/isbndb/isbndb.h for more information.

GENERAL INFORMATION:

  Milo is a library management system, designed for use by school libraries.
  It has been built and designed for use on 32-bit Linux and Windows,
  specifically Kubuntu with kernel version 2.6.31 and Windows XP Service Pack
  3, although it should run fine on any modern Linux installation and any
  later Windows version. Milo uses the MySQL database as a backend data
  storage system, and is therefore dependent on an existing, working MySQL
  installation.

  If you don't already have a Milo database set up, instructions can be found
  in the file DB-SETUP.txt. If you are merely evaluating Milo, instructions
  are included for loading sample data. Alternatively, you can just connect to
  the public test database (you will be able to set these parameters when you
  run Milo):

    Hostname: lane.shacknet.nu
    Database name: milo
    Username: milo-test
    Password: bpa

  As we are hosting this database ourselves, it may be down when you try to
  connect. If this is the case, either try again a few hours later, or set up
  your own database (instructions are in the DB-SETUP file). The best time to
  connect to the test database is 5-9 pm, when we can ensure that the server
  is up.

  If you wish to browse the source code, it can be found in the src/
  subdirectory. Note, however, that all of the source files use Unix-style
  line endings, and will look pretty nasty if opened in Notepad. If you need
  an editor for reading the source, I recommend that you download and install
  Notepad++, <http://notepad-plus.sourceforge.net/uk/site.htm>.

RUNNING MILO:

  The executables and configuration files are contained in the directories
  "linux" and "windows". (If you have these on a CD, you will need to copy
  the correct directory for your operating system to your hard disk - Milo
  needs read/write access to the configuration files.)

  Windows executable: windows/Milo-win32-x86.exe

  Linux executable:   linux/Milo-linux-x86.sh <- IMPORTANT. Run the shell
		      script, NOT the executable. This allows Milo to
		      correctly link with necessary shared libraries.