Skip to content

Commit

Permalink
Mincoin: Update Documentation and Contributions
Browse files Browse the repository at this point in the history
  • Loading branch information
xieta committed Sep 11, 2019
1 parent 7fafb8d commit 46008b4
Show file tree
Hide file tree
Showing 94 changed files with 962 additions and 1,900 deletions.
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Contributing to Bitcoin Core
Contributing to Mincoin Core
============================

The Bitcoin Core project operates an open contributor model where anyone is
The Mincoin Core project operates an open contributor model where anyone is
welcome to contribute towards development in the form of peer review, testing
and patches. This document explains the practical process and guidelines for
contributing.
Expand Down Expand Up @@ -57,12 +57,12 @@ the pull request affects. Valid areas as:

- *Consensus* for changes to consensus critical code
- *Docs* for changes to the documentation
- *Qt* for changes to bitcoin-qt
- *Qt* for changes to mincoin-qt
- *Mining* for changes to the mining code
- *Net* or *P2P* for changes to the peer-to-peer network code
- *RPC/REST/ZMQ* for changes to the RPC, REST or ZMQ APIs
- *Scripts and tools* for changes to the scripts and tools
- *Tests* for changes to the bitcoin unit tests or QA tests
- *Tests* for changes to the mincoin unit tests or QA tests
- *Trivial* should **only** be used for PRs that do not change generated
executable code. Notably, refactors (change of function arguments and code
reorganization) and changes in behavior should **not** be marked as trivial.
Expand Down Expand Up @@ -157,11 +157,11 @@ where possible keep them short, uncomplex and easy to verify.
"Decision Making" Process
-------------------------

The following applies to code changes to the Bitcoin Core project (and related
projects such as libsecp256k1), and is not to be confused with overall Bitcoin
The following applies to code changes to the Mincoin Core project (and related
projects such as libsecp256k1), and is not to be confused with overall Mincoin
Network Protocol consensus changes.

Whether a pull request is merged into Bitcoin Core rests with the project merge
Whether a pull request is merged into Mincoin Core rests with the project merge
maintainers and ultimately the project lead.

Maintainers will take into consideration if a patch is in line with the general
Expand All @@ -179,7 +179,7 @@ In general, all pull requests must:
- where bugs are fixed, where possible, there should be unit tests
demonstrating the bug and also proving the fix. This helps prevent regression.

Patches that change Bitcoin consensus rules are considerably more involved than
Patches that change Mincoin consensus rules are considerably more involved than
normal because they affect the entire ecosystem and so must be preceded by
extensive mailing list discussions and have a numbered BIP. While each case will
be different, one should be prepared to expend more time and effort than for
Expand Down Expand Up @@ -220,7 +220,7 @@ higher in terms of discussion and peer review requirements, keeping in mind that
mistakes could be very costly to the wider community. This includes refactoring
of consensus critical code.

Where a patch set proposes to change the Bitcoin consensus, it must have been
Where a patch set proposes to change the Mincoin consensus, it must have been
discussed extensively on the mailing list and IRC, be accompanied by a widely
discussed BIP and have a generally widely perceived technical consensus of being
a worthwhile change based on the judgement of the maintainers.
Expand All @@ -229,7 +229,7 @@ a worthwhile change based on the judgement of the maintainers.
Release Policy
--------------

The project leader is the release manager for each Bitcoin Core release.
The project leader is the release manager for each Mincoin Core release.

Copyright
---------
Expand Down
4 changes: 2 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Building Bitcoin
Building Mincoin
================

See doc/build-*.md for instructions on building the various
elements of the Bitcoin Core reference implementation of Bitcoin.
elements of the Mincoin Core reference implementation of Mincoin.
14 changes: 7 additions & 7 deletions contrib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Construct a linear, no-fork, best version of the blockchain.

### [Qos](/contrib/qos) ###

A Linux bash script that will set up traffic control (tc) to limit the outgoing bandwidth for connections to the Bitcoin network. 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.
A Linux bash script that will set up traffic control (tc) to limit the outgoing bandwidth for connections to the Mincoin network. This means one can have an always-on mincoind instance running, and another local mincoind/mincoin-qt instance which connects to this node and receives blocks from it.

### [Seeds](/contrib/seeds) ###
Utility to generate the pnSeed[] array that is compiled into the client.
Expand All @@ -22,20 +22,20 @@ Build Tools and Keys
---------------------

### [Debian](/contrib/debian) ###
Contains files used to package bitcoind/bitcoin-qt
for Debian-based Linux systems. If you compile bitcoind/bitcoin-qt yourself, there are some useful files here.
Contains files used to package mincoind/mincoin-qt
for Debian-based Linux systems. If you compile mincoind/mincoin-qt yourself, there are some useful files here.

### [Gitian-descriptors](/contrib/gitian-descriptors) ###
Notes on getting Gitian builds up and running using KVM.

### [Gitian-keys](/contrib/gitian-keys)
PGP keys used for signing Bitcoin Core [Gitian release](/doc/release-process.md) results.
PGP keys used for signing Mincoin Core [Gitian release](/doc/release-process.md) results.

### [MacDeploy](/contrib/macdeploy) ###
Scripts and notes for Mac builds.

### [RPM](/contrib/rpm) ###
RPM spec file for building bitcoin-core on RPM based distributions
RPM spec file for building mincoin-core on RPM based distributions

### [Gitian-build](/contrib/gitian-build.sh) ###
Script for running full Gitian builds.
Expand All @@ -44,7 +44,7 @@ Test and Verify Tools
---------------------

### [TestGen](/contrib/testgen) ###
Utilities to generate test vectors for the data-driven Bitcoin tests.
Utilities to generate test vectors for the data-driven Mincoin tests.

### [Verify Binaries](/contrib/verifybinaries) ###
This script attempts to download and verify the signature file SHA256SUMS.asc from bitcoin.org.
This script attempts to download and verify the signature file SHA256SUMS.asc from mincoin.us.
16 changes: 8 additions & 8 deletions contrib/debian/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@

Debian
====================
This directory contains files used to package bitcoind/bitcoin-qt
for Debian-based Linux systems. If you compile bitcoind/bitcoin-qt yourself, there are some useful files here.
This directory contains files used to package mincoind/mincoin-qt
for Debian-based Linux systems. If you compile mincoind/mincoin-qt yourself, there are some useful files here.

## bitcoin: URI support ##
## mincoin: URI support ##


bitcoin-qt.desktop (Gnome / Open Desktop)
mincoin-qt.desktop (Gnome / Open Desktop)
To install:

sudo desktop-file-install bitcoin-qt.desktop
sudo desktop-file-install mincoin-qt.desktop
sudo update-desktop-database

If you build yourself, you will either need to modify the paths in
the .desktop file or copy or symlink your bitcoin-qt binary to `/usr/bin`
and the `../../share/pixmaps/bitcoin128.png` to `/usr/share/pixmaps`
the .desktop file or copy or symlink your mincoin-qt binary to `/usr/bin`
and the `../../share/pixmaps/mincoin128.png` to `/usr/share/pixmaps`

bitcoin-qt.protocol (KDE)
mincoin-qt.protocol (KDE)

13 changes: 0 additions & 13 deletions contrib/debian/bitcoin-qt.desktop

This file was deleted.

6 changes: 0 additions & 6 deletions contrib/debian/bitcoin-qt.install

This file was deleted.

1 change: 0 additions & 1 deletion contrib/debian/bitcoin-qt.manpages

This file was deleted.

1 change: 0 additions & 1 deletion contrib/debian/bitcoin-tx.bash-completion

This file was deleted.

1 change: 0 additions & 1 deletion contrib/debian/bitcoin-tx.install

This file was deleted.

1 change: 0 additions & 1 deletion contrib/debian/bitcoin-tx.manpages

This file was deleted.

2 changes: 0 additions & 2 deletions contrib/debian/bitcoind.bash-completion

This file was deleted.

1 change: 0 additions & 1 deletion contrib/debian/bitcoind.examples

This file was deleted.

2 changes: 0 additions & 2 deletions contrib/debian/bitcoind.install

This file was deleted.

2 changes: 0 additions & 2 deletions contrib/debian/bitcoind.manpages

This file was deleted.

Loading

0 comments on commit 46008b4

Please sign in to comment.