Skip to content

Commit 27e2d8b

Browse files
super3super3
committed
Finished /Contrib Index. Standardized READMEs.
File and Link Fix.
1 parent dd9bd86 commit 27e2d8b

File tree

17 files changed

+102
-49
lines changed

17 files changed

+102
-49
lines changed

‎contrib/README.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
Contrib Index
22
---------------------
33

4+
### [BitRPC](/contrib/bitrpc) ###
5+
Added bitrpc.py which allows for sending of all standard Bitcoin commands via RPC rather than as command line args.
6+
47
### [Debian](/contrib/debian) ###
58
Contains files used to package bitcoind/bitcoin-qt
69
for Debian-based Linux systems. If you compile bitcoind/bitcoin-qt yourself, there are some useful files here.
@@ -11,7 +14,10 @@ Gavin's notes on getting gitian builds up and running using KVM.
1114
### [Gitian-downloader](/contrib/gitian-downloader)
1215
Various PGP files of core developers.
1316

14-
### [Macdeploy](/contrib/macdeploy) ###
17+
### [Linearize](/contrib/linearize) ###
18+
Construct a linear, no-fork, best version of the blockchain.
19+
20+
### [MacDeploy](/contrib/macdeploy) ###
1521
Scripts and notes for Mac builds.
1622

1723
### [PyMiner](/contrib/pyminer) ###
@@ -31,4 +37,14 @@ Use the raw transactions API to send coins received on a particular
3137
address (or addresses).
3238

3339
### [TestGen](/contrib/testgen) ###
34-
Utilities to generate test vectors for the data-driven Bitcoin tests.
40+
Utilities to generate test vectors for the data-driven Bitcoin tests.
41+
42+
### [Test Patches](/contrib/test-patches) ###
43+
These patches are applied when the automated pull-tester
44+
tests each pull and when master is tested using jenkins.
45+
46+
### [Verify SF Binaries](/contrib/verifysfbinaries) ###
47+
This script attempts to download and verify the signature file SHA256SUMS.asc from SourceForge.
48+
49+
### [Wallet Tools](/contrib/wallettools) ###
50+
Contains a wallet change password and unlock script.

‎contrib/bitrpc/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
### BitRPC ###
2+
Allows for sending of all standard Bitcoin commands via RPC rather than as command line args.

‎contrib/gitian-descriptors/README ‎contrib/gitian-descriptors/README.md

+23-21
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
1-
Gavin's notes on getting gitian builds up and running using KVM:
1+
### Gavin's notes on getting gitian builds up and running using KVM:###
22

33
These instructions distilled from:
4-
https://help.ubuntu.com/community/KVM/Installation
4+
[ https://help.ubuntu.com/community/KVM/Installation]( https://help.ubuntu.com/community/KVM/Installation)
55
... see there for complete details.
66

77
You need the right hardware: you need a 64-bit-capable CPU with hardware virtualization support (Intel VT-x or AMD-V). Not all modern CPUs support hardware virtualization.
88

99
You probably need to enable hardware virtualization in your machine's BIOS.
1010

1111
You need to be running a recent version of 64-bit-Ubuntu, and you need to install several prerequisites:
12-
sudo apt-get install ruby apache2 git apt-cacher-ng python-vm-builder qemu-kvm
12+
13+
sudo apt-get install ruby apache2 git apt-cacher-ng python-vm-builder qemu-kvm
1314

1415
Sanity checks:
15-
sudo service apt-cacher-ng status # Should return apt-cacher-ng is running
16-
ls -l /dev/kvm # Should show a /dev/kvm device
16+
17+
sudo service apt-cacher-ng status # Should return apt-cacher-ng is running
18+
ls -l /dev/kvm # Should show a /dev/kvm device
1719

1820

1921
Once you've got the right hardware and software:
@@ -22,10 +24,12 @@ Once you've got the right hardware and software:
2224
git clone git://github.com/devrandom/gitian-builder.git
2325
mkdir gitian-builder/inputs
2426
cd gitian-builder/inputs
27+
2528
# Inputs for Linux and Win32:
2629
wget -O miniupnpc-1.6.tar.gz 'http://miniupnp.tuxfamily.org/files/download.php?file=miniupnpc-1.6.tar.gz'
2730
wget 'http://fukuchi.org/works/qrencode/qrencode-3.2.0.tar.bz2'
28-
# Inputs for Win32: (Linux has packages for these)
31+
32+
# Inputs for Win32: (Linux has packages for these)
2933
wget 'https://downloads.sourceforge.net/project/boost/boost/1.50.0/boost_1_50_0.tar.bz2'
3034
wget 'http://www.openssl.org/source/openssl-1.0.1c.tar.gz'
3135
wget 'http://download.oracle.com/berkeley-db/db-4.8.30.NC.tar.gz'
@@ -58,31 +62,29 @@ Once you've got the right hardware and software:
5862

5963
---------------------
6064

61-
gitian-builder now also supports building using LXC. See
62-
https://help.ubuntu.com/12.04/serverguide/lxc.html
65+
`gitian-builder` now also supports building using LXC. See
66+
[ https://help.ubuntu.com/12.04/serverguide/lxc.html]( https://help.ubuntu.com/12.04/serverguide/lxc.html)
6367
... for how to get LXC up and running under Ubuntu.
6468

6569
If your main machine is a 64-bit Mac or PC with a few gigabytes of memory
66-
and at least 10 gigabytes of free disk space, you can gitian-build using
70+
and at least 10 gigabytes of free disk space, you can `gitian-build` using
6771
LXC running inside a virtual machine.
6872

6973
Here's a description of Gavin's setup on OSX 10.6:
7074

71-
1. Download and install VirtualBox from https://www.virtualbox.org/
75+
1. Download and install VirtualBox from [https://www.virtualbox.org/](https://www.virtualbox.org/)
7276

7377
2. Download the 64-bit Ubuntu Desktop 12.04 LTS .iso CD image from
74-
http://www.ubuntu.com/
78+
[http://www.ubuntu.com/](http://www.ubuntu.com/)
7579

76-
3. Run VirtualBox and create a new virtual machine, using the
77-
Ubuntu .iso (see the VirtualBox documentation for details).
78-
Create it with at least 2 gigabytes of memory and a disk
79-
that is at least 20 gigabytes big.
80+
3. Run VirtualBox and create a new virtual machine, using the Ubuntu .iso (see the [VirtualBox documentation](https://www.virtualbox.org/wiki/Documentation) for details). Create it with at least 2 gigabytes of memory and a disk that is at least 20 gigabytes big.
8081

8182
4. Inside the running Ubuntu desktop, install:
82-
sudo apt-get install debootstrap lxc ruby apache2 git apt-cacher-ng python-vm-builder
8383

84-
5. Still inside Ubuntu, tell gitian-builder to use LXC, then follow the "Once you've got the right
85-
hardware and software" instructions above:
86-
export USE_LXC=1
87-
git clone git://github.com/bitcoin/bitcoin.git
88-
... etc
84+
sudo apt-get install debootstrap lxc ruby apache2 git apt-cacher-ng python-vm-builder
85+
86+
5. Still inside Ubuntu, tell gitian-builder to use LXC, then follow the "Once you've got the right hardware and software" instructions above:
87+
88+
export USE_LXC=1
89+
git clone git://github.com/bitcoin/bitcoin.git
90+
... etc

‎contrib/linearize/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
### Linearize ###
2+
Construct a linear, no-fork, best version of the blockchain.

‎contrib/misc/example-linearize.cfg ‎contrib/linearize/example-linearize.cfg

File renamed without changes.

‎contrib/misc/linearize.py ‎contrib/linearize/linearize.py

File renamed without changes.

‎contrib/macdeploy/README.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
### MacDeploy ###
2+
3+
You will need the appscript package for the fancy disk image creation to work:
4+
5+
sudo easy_install appscript
6+
7+
For Snow Leopard (which uses [Python 2.6](http://www.python.org/download/releases/2.6/)), you will need the param_parser package:
8+
9+
sudo easy_install argparse
10+
11+
This script should not be run manually, instead, after building as usual:
12+
13+
make deploy
14+
15+
During the process, the disk image window will pop up briefly where the fancy
16+
settings are applied. This is normal, please do not interfere.
17+
18+
When finished, it will produce `Bitcoin-Qt.dmg`.
19+

‎contrib/macdeploy/notes.txt

-14
This file was deleted.

‎contrib/pyminer/README ‎contrib/pyminer/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
### PyMiner ###
12

2-
This is a 'getwork' CPU mining client for bitcoin.
3+
This is a 'getwork' CPU mining client for Bitcoin.
34

45
It is pure-python, and therefore very, very slow. The purpose is to
56
provide a reference implementation of a miner, for study.

‎contrib/qos/README ‎contrib/qos/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
### Qos ###
2+
13
This is a Linux bash script that will set up tc to limit the outgoing bandwidth for connections to the Bitcoin network. It limits outbound TCP traffic with a source or destination port of 8333, but not if the destination IP is within a LAN (defined as 192.168.x.x).
24

35
This means one can have an always-on bitcoind instance running, and another local bitcoind/bitcoin-qt instance which connects to this node and receives blocks from it.

‎contrib/seeds/README ‎contrib/seeds/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1+
### Seeds ###
2+
13
Utility to generate the pnSeed[] array that is compiled into the client
2-
(see src/net.cpp).
4+
(see [src/net.cpp](/src/net.cpp)).
35

46
The 600 seeds compiled into the 0.8 release were created from sipa's DNS seed data, like this:
57

6-
curl -s http://bitcoin.sipa.be/seeds.txt | head -1000 | makeseeds.py
8+
curl -s http://bitcoin.sipa.be/seeds.txt | head -1000 | makeseeds.py
79

810
The input to makeseeds.py is assumed to be approximately sorted from most-reliable to least-reliable,
911
with IP:port first on each line (lines that don't match IPv4:port are ignored).

‎contrib/spendfrom/README ‎contrib/spendfrom/README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,30 @@
1+
### SpendFrom ###
2+
13
Use the raw transactions API to send coins received on a particular
24
address (or addresses).
35

4-
Depends on jsonrpc
6+
Depends on `jsonrpc`
57

68
Usage:
79

8-
spendfrom.py --from=FROMADDRESS1[,FROMADDRESS2] --to=TOADDRESS --amount=amount \
9-
--fee=fee --datadir=/path/to/.bitcoin --testnet --dry_run
10+
spendfrom.py --from=FROMADDRESS1[,FROMADDRESS2] --to=TOADDRESS --amount=amount \
11+
--fee=fee --datadir=/path/to/.bitcoin --testnet --dry_run
1012

1113
With no arguments, outputs a list of amounts associated with addresses.
1214

13-
With arguments, sends coins received by the FROMADDRESS addresses to the TOADDRESS.
15+
With arguments, sends coins received by the `FROMADDRESS` addresses to the `TOADDRESS`.
1416

1517
You may explictly specify how much fee to pay (a fee more than 1% of the amount
1618
will fail, though, to prevent bitcoin-losing accidents). Spendfrom may fail if
1719
it thinks the transaction would never be confirmed (if the amount being sent is
1820
too small, or if the transaction is too many bytes for the fee).
1921

2022
If a change output needs to be created, the change will be sent to the last
21-
FROMADDRESS (if you specify just one FROMADDRESS, change will go back to it).
23+
`FROMADDRESS` (if you specify just one `FROMADDRESS`, change will go back to it).
2224

23-
If --datadir is not specified, the default datadir is used.
25+
If `--datadir` is not specified, the default datadir is used.
2426

25-
The --dry_run option will just create and sign the the transaction and print
27+
The `--dry_run` option will just create and sign the the transaction and print
2628
the transaction data (as hexadecimal), instead of broadcasting it.
2729

2830
If the transaction is created and broadcast successfully, a transaction id

‎contrib/test-patches/README ‎contrib/test-patches/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1+
### Test Patches ###
2+
13
These patches are applied when the automated pull-tester
24
tests each pull and when master is tested using jenkins.
35
You can find more information about the tests run at
4-
http://jenkins.bluematt.me/pull-tester/files/
6+
[http://jenkins.bluematt.me/pull-tester/files/
7+
](http://jenkins.bluematt.me/pull-tester/files/)

‎contrib/testgen/README

-1
This file was deleted.

‎contrib/testgen/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
### TestGen ###
2+
3+
Utilities to generate test vectors for the data-driven Bitcoin tests.
4+
5+
Usage:
6+
7+
gen_base58_test_vectors.py valid 50 > ../../src/test/data/base58_keys_valid.json
8+
gen_base58_test_vectors.py invalid 50 > ../../src/test/data/base58_keys_invalid.json

‎contrib/verifysfbinaries/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
### Verify SF Binaries ###
2+
This script attempts to download the signature file `SHA256SUMS.asc` from SourceForge.
3+
4+
It first checks if the signature passes, and then downloads the files specified in
5+
the file, and checks if the hashes of these files match those that are specified
6+
in the signature file. The script returns 0 if everything passes the checks. It returns 1 if either the
7+
signature check or the hash check doesn't pass. If an error occurs the return value is 2

‎contrib/wallettools/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
### Wallet Tools ###
2+
Contains a wallet change password and unlock script.

0 commit comments

Comments
 (0)