src/README

   1 # Copyright (C) 2011 Diego Pardilla Mata
   2 #
   3 # This file is part of SpiderBOY.
   4 #
   5 # SpiderBOY is free software: you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation, either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
  17 This is the SpiderBoy crawler.
  18 It has (among others) the following major features
  19 Search URL's from another URL and with a depth indicated
  20 Installation:
  21 See INSTALL file for information on how to install SpiderBOY
  22 Starting SpiderBOY:
  23 run from the command line: `spiderboy.py [-h] [-n NUMBER_OF_LEVELS] [url]'
  24 run `spiderboy.py -h' for more startup options
  25 More information:
  26 http://code.sidelab.es/projects/diegopardilla/wiki
  27 Written by:
  28 see AUTHORS for more information
  29 Reporting Bugs:
  30 Please report bugs to our mailing list or our bugtracker:
  31 munikes@members.fsf.org
  32 pardilla@members.fsf.org
  33 http://code.sidelab.es/projects/diegopardilla/issues/new
  34 Contacting us:
  35 http://packages.python.org/SpiderBOY (homepage)
  36 munikes@members.fsf.org (mUniKeS)
  37 pardilla@members.fsf.org (Diego Pardilla)