Permalink
Browse files

Rewrote README.

  • Loading branch information...
John Tobey John Tobey
John Tobey authored and John Tobey committed Jul 12, 2011
1 parent e903a11 commit d5f46ff7b06072dfa865ead52673e825564ae200
Showing with 109 additions and 57 deletions.
  1. +108 −0 README.md
  2. +0 −57 README.txt
  3. +1 −0 README.txt
View
108 README.md
@@ -0,0 +1,108 @@
+Abe: a free block chain browser for Bitcoin-based currencies.
+https://github.com/jtobey/bitcoin-abe
+Copyright(C) 2011 by John Tobey <John.Tobey@gmail.com>
+License: GNU Affero General Public License, see the file LICENSE.txt.
+Portions Copyright (c) 2010 Gavin Andresen, see bct-LICENSE.txt.
+
+Welcome to Abe!
+===============
+
+This software reads the Bitcoin block file, transforms and loads the
+data into a database, and presents a web interface similar to Bitcoin
+Block Explorer, http://blockexplorer.com/.
+
+Abe draws inspiration from Bitcoin Block Explorer (BBE) and seeks some
+level of compatibility with it but uses a completely new
+implementation. This software is in "alpha" status and has not yet
+been optimised to run as fast as BBE.
+
+Dependencies
+------------
+
+This program depends on Python Crypto modules (Debian package
+python-crypto) and a database such as SQLite (python-pysqlite2) or
+PostgreSQL (see README-POSTGRES.txt). Other SQL databases may work
+with minor changes. You will need a copy of the block file
+(blk0001.dat in your Bitcoin directory). You may let Abe read the
+block file while Bitcoin runs.
+
+License
+-------
+
+The GNU Affero General Public License (LICENSE.txt) requires whoever
+modifies this code and runs it on a server to make the modified code
+available to users of the server. You may do this by forking the
+Github project (if you received this code from Github.com), keeping
+your modifications in the new project, and linking to it in the page
+template. Or you may wish to satisfy the requirement by simply
+passing "--auto-agpl" to "abe.py". This option makes all files in the
+directory containing abe.py and its subdirectories available to
+clients. See the comments in abe.conf for more information.
+
+Database
+--------
+
+For usage, run "abe.py --help" and see the comments in abe.conf.
+
+You will have to specify a database driver and connection arguments
+(dbtype and connect-args in abe.conf). The dbtype is the name of a
+Python module that supports your database. Known to work are psycopg2
+(for PostgreSQL) and sqlite3. The value of connect-args depends on
+your database configuration; consult the module's documentation of the
+connect() method.
+
+You may specify connect-args in any of the following forms:
+
+* omit connect-args to call connect() with no arguments
+
+* named arguments as a JSON object, e.g.:
+ connect-args = { "database": "abe", "password": "b1tc0!n" }
+
+* multiple arguments as a JSON array, e.g.:
+ connect-args = ["abe", "abe", "b1tc0!n"]
+
+* a single string argument on one line, e.g.:
+ connect-args = /var/lib/abe/abe.sqlite
+
+For JSON syntax, see http://www.json.org.
+
+Slow startup
+------------
+
+Reading the block file takes far too long: hours on PostgreSQL and
+days on SQLite3. (We hope to improve the speed soon.) However, if
+you use a persistent database, Abe remembers where it stopped reading
+and starts more quickly the second time.
+
+Web server
+----------
+
+By default, Abe expects to be run in a FastCGI environment. For a
+rough overview of FastCGI setup, see README-FASTCGI.txt.
+
+To run the built-in HTTP server instead of FastCGI, specify a TCP port
+and network interface in abe.conf, e.g.:
+
+> port 2750
+> host 127.0.0.1 # or a domain name
+
+Input
+-----
+
+To display Namecoin or any block chain with data somewhere other than
+the default Bitcoin directory specify "datadir" in abe.conf, e.g.:
+
+> datadir = /home/bitcoin/.namecoin
+
+Note that this software is currently unaware of name transactions.
+
+More information
+----------------
+
+Please see TODO.txt for a list of what is not yet implemented but
+would like to be.
+
+Forum thread: https://forum.bitcoin.org/index.php?topic=16141.0
+
+Donations appreciated: 1PWC7PNHL1SgvZaN7xEtygenKjWobWsCuf (BTC)
+NJ3MSELK1cWnqUa6xhF2wUYAnz3RSrWXcK (NMC)
View
@@ -1,57 +0,0 @@
-Abe: a free block chain browser for Bitcoin-based currencies.
-Copyright(C) 2011 by John Tobey <John.Tobey@gmail.com>
-License: GNU Affero General Public License, see the file LICENSE.txt.
-Portions Copyright (c) 2010 Gavin Andresen, see bct-LICENSE.txt.
-
-Welcome to Abe!
-
-This software reads the Bitcoin block file, transforms and loads the
-data into a database, and presents a web interface similar to the
-original Block Explorer by theymos, http://blockexplorer.com/.
-
-Abe draws inspiration from BlockExplorer.com and seeks some level of
-compatibility with it but uses a completely new implementation.
-
-This program depends on Python Crypto modules (Debian package
-python-crypto) and a database such as SQLite (python-pysqlite2) or
-PostgreSQL. Other SQL databases may work with minor changes. You
-will need a copy of the block file (blk0001.dat in your Bitcoin
-directory). You may let Abe read the block file while Bitcoin runs.
-
-The GNU Affero General Public License requires whoever modifies this
-code and runs it on a server to make the modified code available to
-users of the server. You may do this by forking the Github project
-(if you received this code from Github.com), keeping your
-modifications in the new project, and linking to it in the page
-template. Or you may wish to satisfy the requirement by simply
-passing "--auto-agpl" to "abe.py". This option makes all files in the
-directory containing abe.py and its subdirectories available to
-clients. See the comments in abe.conf for more information.
-
-For usage, run "abe.py --help" and see the comments in abe.conf. By
-default, Abe reads your Bitcoin blk0001.dat file, builds an in-memory
-database, and runs a chain viewer over FastCGI.
-
-BUG: Reading the block file takes far too long, hours on PostgreSQL
-and days on SQLite3. However, if you use a persistent database (the
-default is not persistent) Abe remembers where it stopped reading and
-starts more quickly the second time.
-
-See `abe.py --help` for examples of how to persist the data, greatly
-reducing start time. See README-POSTGRES.txt for a rough idea of how
-to set up PostgreSQL.
-
-To run the built-in HTTP server instead of FastCGI, add "--port 2750"
-or a TCP port number of your choosing. For a rough overview of
-FastCGI setup, see README-FASTCGI.txt.
-
-To explore Namecoin (or a chain with data somewhere other than the
-default Bitcoin directory) pass, e.g., "--datadir ~/.namecoin". Note
-that this software is currently unaware of name transactions.
-
-Please see TODO.txt for a list of what is not yet implemented but
-would like to be.
-
-Forum thread: https://forum.bitcoin.org/index.php?topic=16141.0
-Donations appreciated: 1PWC7PNHL1SgvZaN7xEtygenKjWobWsCuf (BTC)
-NJ3MSELK1cWnqUa6xhF2wUYAnz3RSrWXcK (NMC)
View

0 comments on commit d5f46ff

Please sign in to comment.