Skip to content

Commit

Permalink
Add more documentation to the README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
tdb committed Mar 20, 2004
1 parent 6408e37 commit 3cd0c13
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
19 changes: 19 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,22 @@ $Id$

pystatgrab contains python bindings for libstatgrab. For information
on libstatgrab see the libstatgrab website given above.

There is currently very little documentation for pystatgrab.
Installation is a normal distutils setup:

./setup.py install

The functions available through pystatgrab directly match those of
the libstatgrab functions. Documentation on those functions can be
found in the libstatgrab package, or on the libstatgrab website.

The return types of the functions are dictionaries, sometimes
contained within an array if more than one item is being returned.
These map pretty much directly on to the C structures returned by
libstatgrab.

Please let us know if you have any problems - support@i-scream.org.

If you find a bug, help us to fix it by sending details to
bugs@i-scream.org. If you have a patch, please send it too.
18 changes: 17 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
#!/usr/bin/env python
#
# setup.py - distfiles configuration for pystatgrab
# i-scream central monitoring system
# http://www.i-scream.org
# Copyright (C) 2000-2004 i-scream
#
# 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.
#
# $Id$
#
Expand Down

0 comments on commit 3cd0c13

Please # to comment.