Commit c64c88ec authored by Tiago Peixoto's avatar Tiago Peixoto

Update README and remove outdated crud (ChangeLog, TODO, etc)

parent 4eca7b1e
To see the full detailed changelog, see the git repository
at git://git.skewed.de/graph-tool or http://git.skewed.de/?p=graph-tool
......@@ -4,12 +4,10 @@ SUBDIRS = src
graphtooldocdir = ${PACKAGE_DOC_DIR}
nobase_dist_graphtooldoc_DATA = \
README\
README.md\
COPYING\
AUTHORS\
INSTALL\
NEWS\
TODO\
src/boost-workaround/LICENSE_1_0.txt\
doc/centrality.rst \
doc/correlations.rst \
......
See the website for details: http://graph-tool.skewed.de
\ No newline at end of file
graph-tool -- an efficient python module for analysis of graphs
===============================================================
graph-tool --- an efficient python module for analysis of graphs
================================================================
graph-tool is an efficient python module for manipulation and
statistical analysis of graphs. It contains several general graph
measurements data structures and algorithms, such as degree or
properties distributions, degree or properties correlations,
clustering, graph filtering, graph layout, and more, as well as a
random graph generation routine. For more information and
documentation, please take a look at the website
http://graph-tool.skewed.de.
clustering, graph filtering, interactive graph layout, random graph
generation, detection of community structure, and more.
Contrary to most other python modules with similar functionality, the
core data structures and algorithms are implemented in C++, making
extensive use of template metaprogramming, based heavily on the Boost
Graph Library. This confers it a level of performance that is
comparable (both in memory usage and computation time) to that of a
pure C/C++ library.
For more information and documentation, please take a look at the
website http://graph-tool.skewed.de.
graph-tool is free software, you can redistribute it and/or modify it
under the terms of the GNU General Public License, version 3 or
......@@ -19,39 +27,37 @@ WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
Availability
============
------------
The current stable version of graph-tool is always available from the
project's website: http://graph-tool.skewed.de
Installation
============
------------
graph-tool follows the standard GNU installation procedure. Please
consult the INSTALL file in this distribution for more detailed
instructions.
Note that recent versions of GCC (4.4 or above) are required for
compilation, and due to the usage of template metaprogramming
techniques in the program, relatively large amounts of RAM are
required during compilation. You have been warned! For this reason,
pre-compiled packages are available in the website.
Note that recent versions of GCC (4.8 or above) or clang, with good
c++11 support, are required for compilation. Due to the heavy use of
template metaprogramming techniques, *relatively large amounts of RAM
are required during compilation*. You have been warned! For this
reason, pre-compiled packages are available in the website.
More information about graph-tool
==================================
---------------------------------
The project homepage is http://graph-tool.skewed.de. It contains
documentation, info on mailing lists, a wiki, as well as a
bug-tracking function. You should be reading it, instead of this. :-)
See the NEWS file for recent changes to the program.
documentation, info on mailing lists, as well as a bug-tracking
function. You should be reading it, instead of this. :-)
Reporting Bugs
==============
--------------
A list of known bugs can be found in the website:
http://graph-tool.skewed.de/tickets
http://graph-tool.skewed.de/issues
If you found a bug in the program which is not included in this list,
please submit a ticket through the provided interface.
......
see website for details: http://graph-tool.skewed.de
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment