docs: Add fullblocktests entry and minor consistency updates

blockchain/fullblocktests/doc.go

@@ -0,0 +1,20 @@
+// Copyright (c) 2016 The btcsuite developers
+// Use of this source code is governed by an ISC
+// license that can be found in the LICENSE file.
+
+/*
+Package fullblocktests provides a set of block consensus validation tests.
+
+All of the generated test instances involve full blocks that are to be used for
+testing the consensus validation rules.  The tests are intended to be flexible
+enough to allow both unit-style tests directly against the blockchain code as
+well as integration style tests over the peer-to-peer network.  To achieve that
+goal, each test contains additional information about the expected result,
+however that information can be ignored when doing comparison tests between two
+independent versions over the peer-to-peer network.
+
+This package has intentionally been designed so it can be used as a standalone
+package for any projects needing to test their implementation against a full set
+of blocks that excerise the consensus validation rules.
+*/
+package fullblocktests

docs/README.md

@@ -199,27 +199,29 @@ information.
 <a name="GoPackages" />
 
 * The Decred-related Go Packages:
-    * [dcrrpcclient](https://github.com/decred/dcrrpcclient) - Implements a
-	  robust and easy to use Websocket-enabled Decred JSON-RPC client
-    * [dcrjson](https://github.com/decred/dcrjson) - Provides an extensive API
-	  for the underlying JSON-RPC command and return values
-    * [wire](https://github.com/decred/dcrd/tree/master/wire) - Implements the
-	  Decred wire protocol
-    * [peer](https://github.com/decred/dcrd/tree/master/peer) -
-	  Provides a common base for creating and managing Decred network peers.
-    * [blockchain](https://github.com/decred/dcrd/tree/master/blockchain) -
-	  Implements Decred block handling and chain selection rules
-    * [txscript](https://github.com/decred/dcrd/tree/master/txscript) -
-	  Implements the Decred transaction scripting language
-    * [dcrec](https://github.com/decred/dcrd/tree/master/dcrec) - Implements
-	  support for the elliptic curve cryptographic functions needed for the
-	  Decred scripts
-    * [database](https://github.com/decred/dcrd/tree/master/database) -
-	  Provides a database interface for the Decred block chain
-    * [dcrutil](https://github.com/decred/dcrd/tree/master/dcrutil) - Provides Decred-specific
-	  convenience functions and types
-    * [chainhash](https://github.com/decred/dcrd/tree/master/chaincfg/chainhash) -
-	  Provides a generic hash type and associated functions that allows the
-	  specific hash algorithm to be abstracted.
-    * [connmgr](https://github.com/decred/dcrd/tree/master/connmgr) -
-      Package connmgr implements a generic Decred network connection manager.
+  * [dcrrpcclient](https://github.com/decred/dcrrpcclient) - Implements a
+    robust and easy to use Websocket-enabled Decred JSON-RPC client
+  * [dcrjson](https://github.com/decred/dcrjson) - Provides an extensive API
+    for the underlying JSON-RPC command and return values
+  * [wire](https://github.com/decred/dcrd/tree/master/wire) - Implements the
+    Decred wire protocol
+  * [peer](https://github.com/decred/dcrd/tree/master/peer) -
+    Provides a common base for creating and managing Decred network peers.
+  * [blockchain](https://github.com/decred/dcrd/tree/master/blockchain) -
+    Implements Decred block handling and chain selection rules
+  * [blockchain/fullblocktests](https://github.com/decred/dcrd/tree/master/blockchain/fullblocktests) -
+    Provides a set of block tests for testing the consensus validation rules
+  * [txscript](https://github.com/decred/dcrd/tree/master/txscript) -
+    Implements the Decred transaction scripting language
+  * [dcrec](https://github.com/decred/dcrd/tree/master/dcrec) - Implements
+    support for the elliptic curve cryptographic functions needed for the
+    Decred scripts
+  * [database](https://github.com/decred/dcrd/tree/master/database) -
+    Provides a database interface for the Decred block chain
+  * [dcrutil](https://github.com/decred/dcrd/tree/master/dcrutil) - Provides
+    Decred-specific convenience functions and types
+  * [chainhash](https://github.com/decred/dcrd/tree/master/chaincfg/chainhash) -
+    Provides a generic hash type and associated functions that allows the
+    specific hash algorithm to be abstracted.
+  * [connmgr](https://github.com/decred/dcrd/tree/master/connmgr) -
+    Package connmgr implements a generic Decred network connection manager.