README
author Nicolas Chauvat <nicolas.chauvat@logilab.fr>
Mon, 23 Jun 2008 13:42:22 +0200
changeset 6 6aad8b499e86
parent 0 7710b138d4eb
permissions -rw-r--r--
fix reST markup

oobrother
=========


What's this ?
-------------
OoBrother is a pure-python graphical filesystem browser,
mainly designed to help python developers.

Among other features, OoObrother :

  - can be used as a speedbar (open each files with emacsclient)
  - provides VCS facilities
  - helps Debian package creations
  - launches unittests
  - checks modules and packages with pylint and pychecker

The most important thing is that you can easily customize OoBrother
with your own plugins.



Installation
------------

Extract the tarball, jump into the created directory and run ::

	python setup.py install

For installation options, see ::

	python setup.py install --help

License
-------
This program 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 2 of the License, or (at your option) any later
version.

This program 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
this program; if not, write to the Free Software Foundation, Inc.,
59 Temple Place - Suite 330, Boston, MA  02111-1307
USA.

On Debian systems, the complete text of the GNU General Public License
may be found in '/usr/share/common-licenses/GPL'.