Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = "Bitcoin Core"
PROJECT_NAME = "XPChain Core"

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
Expand Down Expand Up @@ -1265,15 +1265,15 @@ DOCSET_FEEDNAME = "Doxygen generated docs"
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_DOCSET is set to YES.

DOCSET_BUNDLE_ID = org.bitcoin.Bitcoin-Core
DOCSET_BUNDLE_ID = io.xpchain.XPChain-Core

# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.
# The default value is: org.doxygen.Publisher.
# This tag requires that the tag GENERATE_DOCSET is set to YES.

DOCSET_PUBLISHER_ID = org.bitcoin.Bitcoin-Core
DOCSET_PUBLISHER_ID = io.xpchain.XPChain-Core

# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
# The default value is: Publisher.
Expand Down
24 changes: 12 additions & 12 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,41 @@
Bitcoin Core
XPChain Core
=============

Setup
---------------------
Bitcoin Core is the original Bitcoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Bitcoin transactions (which is currently more than 100 GBs); depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.
XPChain Core is the original XPChain client and it builds the backbone of the network. It downloads and, by default, stores the entire history of XPChain transactions (which is currently more than 100 GBs); depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.

To download Bitcoin Core, visit [bitcoincore.org](https://bitcoincore.org/en/releases/).
To download XPChain Core, visit [xpchaincore.org](https://xpchaincore.org/en/releases/).

Running
---------------------
The following are some helpful notes on how to run Bitcoin Core on your native platform.
The following are some helpful notes on how to run XPChain Core on your native platform.

### Unix

Unpack the files into a directory and run:

- `bin/bitcoin-qt` (GUI) or
- `bin/bitcoind` (headless)
- `bin/xpchain-qt` (GUI) or
- `bin/xpchaind` (headless)

### Windows

Unpack the files into a directory, and then run bitcoin-qt.exe.
Unpack the files into a directory, and then run xpchain-qt.exe.

### macOS

Drag Bitcoin Core to your applications folder, and then run Bitcoin Core.
Drag XPChain Core to your applications folder, and then run XPChain Core.

### Need Help?

* See the documentation at the [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page)
* See the documentation at the [XPChain Wiki](https://en.bitcoin.it/wiki/Main_Page)
for help and more information.
* Ask for help on [#bitcoin](http://webchat.freenode.net?channels=bitcoin) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net?channels=bitcoin).
* Ask for help on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Technical Support board](https://bitcointalk.org/index.php?board=4.0).

Building
---------------------
The following are developer notes on how to build Bitcoin Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
The following are developer notes on how to build XPChain Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.

- [Dependencies](dependencies.md)
- [macOS Build Notes](build-osx.md)
Expand All @@ -47,7 +47,7 @@ The following are developer notes on how to build Bitcoin Core on your native pl

Development
---------------------
The Bitcoin repo's [root README](/README.md) contains relevant information on the development process and automated testing.
The XPChain repo's [root README](/README.md) contains relevant information on the development process and automated testing.

- [Developer Notes](developer-notes.md)
- [Release Notes](release-notes.md)
Expand All @@ -65,7 +65,7 @@ The Bitcoin repo's [root README](/README.md) contains relevant information on th
### Resources
* Discuss on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Development & Technical Discussion board](https://bitcointalk.org/index.php?board=6.0).
* Discuss project-specific development on #bitcoin-core-dev on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net/?channels=bitcoin-core-dev).
* Discuss general Bitcoin development on #bitcoin-dev on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net/?channels=bitcoin-dev).
* Discuss general XPChain development on #bitcoin-dev on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net/?channels=bitcoin-dev).

### Miscellaneous
- [Assets Attribution](assets-attribution.md)
Expand Down
46 changes: 23 additions & 23 deletions doc/README_windows.txt
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
Bitcoin Core
=============
Intro
-----
Bitcoin is a free open source peer-to-peer electronic cash system that is
completely decentralized, without the need for a central server or trusted
parties. Users hold the crypto keys to their own money and transact directly
with each other, with the help of a P2P network to check for double-spending.
Setup
-----
Unpack the files into a directory and run bitcoin-qt.exe.
Bitcoin Core is the original Bitcoin client and it builds the backbone of the network.
However, it downloads and stores the entire history of Bitcoin transactions;
depending on the speed of your computer and network connection, the synchronization
process can take anywhere from a few hours to a day or more.
See the bitcoin wiki at:
https://en.bitcoin.it/wiki/Main_Page
for more help and information.
XPChain Core
=============

Intro
-----
XPChain is a free open source peer-to-peer electronic cash system that is
completely decentralized, without the need for a central server or trusted
parties. Users hold the crypto keys to their own money and transact directly
with each other, with the help of a P2P network to check for double-spending.


Setup
-----
Unpack the files into a directory and run xpchain-qt.exe.

XPChain Core is the original XPChain client and it builds the backbone of the network.
However, it downloads and stores the entire history of XPChain transactions;
depending on the speed of your computer and network connection, the synchronization
process can take anywhere from a few hours to a day or more.

See the xpchain wiki at:
https://en.bitcoin.it/wiki/Main_Page
for more help and information.
2 changes: 1 addition & 1 deletion doc/assets-attribution.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
The list of assets used in the bitcoin source and their attribution can now be found in [contrib/debian/copyright](../contrib/debian/copyright).
The list of assets used in the xpchain source and their attribution can now be found in [contrib/debian/copyright](../contrib/debian/copyright).
4 changes: 2 additions & 2 deletions doc/benchmarking.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Benchmarking
============

Bitcoin Core has an internal benchmarking framework, with benchmarks
XPChain Core has an internal benchmarking framework, with benchmarks
for cryptographic algorithms (e.g. SHA1, SHA256, SHA512, RIPEMD160), as well as the rolling bloom filter.

Running
---------------------
After compiling bitcoin-core, the benchmarks can be run with:
After compiling xpchain-core, the benchmarks can be run with:

src/bench/bench_bitcoin

Expand Down
7 changes: 3 additions & 4 deletions doc/build-freebsd.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ FreeBSD build guide
======================
(updated for FreeBSD 11.1)

This guide describes how to build bitcoind and command-line utilities on FreeBSD.
This guide describes how to build xpchaind and command-line utilities on FreeBSD.

This guide does not contain instructions for building the GUI.

Expand All @@ -24,10 +24,10 @@ See [dependencies.md](dependencies.md) for a complete overview.

Download the source code:
```
git clone https://github.com/bitcoin/bitcoin
git clone https://github.com/xpchain/xpchain
```

## Building Bitcoin Core
## Building XPChain Core

**Important**: Use `gmake` (the non-GNU `make` will exit with an error).

Expand All @@ -43,4 +43,3 @@ gmake
*Note on debugging*: The version of `gdb` installed by default is [ancient and considered harmful](https://wiki.freebsd.org/GdbRetirement).
It is not suitable for debugging a multi-threaded C++ program, not even for getting backtraces. Please install the package `gdb` and
use the versioned gdb command (e.g. `gdb7111`).

6 changes: 3 additions & 3 deletions doc/build-netbsd.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ NetBSD build guide
======================
(updated for NetBSD 7.0)

This guide describes how to build bitcoind and command-line utilities on NetBSD.
This guide describes how to build xpchaind and command-line utilities on NetBSD.

This guide does not contain instructions for building the GUI.

Expand All @@ -25,12 +25,12 @@ python27

Download the source code:
```
git clone https://github.com/bitcoin/bitcoin
git clone https://github.com/xpchain/xpchain
```

See [dependencies.md](dependencies.md) for a complete overview.

### Building Bitcoin Core
### Building XPChain Core

**Important**: Use `gmake` (the non-GNU `make` will exit with an error).

Expand Down
9 changes: 4 additions & 5 deletions doc/build-openbsd.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ OpenBSD build guide
======================
(updated for OpenBSD 6.3)

This guide describes how to build bitcoind and command-line utilities on OpenBSD.
This guide describes how to build xpchaind and command-line utilities on OpenBSD.

OpenBSD is most commonly used as a server OS, so this guide does not contain instructions for building the GUI.

Expand All @@ -17,7 +17,7 @@ pkg_add autoconf # (select highest version, e.g. 2.69)
pkg_add automake # (select highest version, e.g. 1.15)
pkg_add python # (select highest version, e.g. 3.6)

git clone https://github.com/bitcoin/bitcoin.git
git clone https://github.com/xpchain/xpchain.git
```

See [dependencies.md](dependencies.md) for a complete overview.
Expand Down Expand Up @@ -48,7 +48,7 @@ from the root of the repository. Then set `BDB_PREFIX` for the next section:
export BDB_PREFIX="$PWD/db4"
```

### Building Bitcoin Core
### Building XPChain Core

**Important**: use `gmake`, not `make`. The non-GNU `make` will exit with a horrible error.

Expand Down Expand Up @@ -95,12 +95,11 @@ The standard ulimit restrictions in OpenBSD are very strict:
data(kbytes) 1572864

This, unfortunately, in some cases not enough to compile some `.cpp` files in the project,
(see issue [#6658](https://github.com/bitcoin/bitcoin/issues/6658)).
(see issue [#6658](https://github.com/xpchain/xpchain/issues/6658)).

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not change here

There are some changes like this

If your user is in the `staff` group the limit can be raised with:

ulimit -d 3000000

The change will only affect the current shell and processes spawned by it. To
make the change system-wide, change `datasize-cur` and `datasize-max` in
`/etc/login.conf`, and reboot.

30 changes: 15 additions & 15 deletions doc/build-osx.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,17 @@ from the root of the repository.

**Note**: You only need Berkeley DB if the wallet is enabled (see the section *Disable-Wallet mode* below).

Build Bitcoin Core
Build XPChain Core
------------------------

1. Clone the Bitcoin Core source code and cd into `bitcoin`
1. Clone the XPChain Core source code and cd into `xpchain`

git clone https://github.com/bitcoin/bitcoin
cd bitcoin
git clone https://github.com/xpchain/xpchain
cd xpchain

2. Build Bitcoin Core:
2. Build XPChain Core:

Configure and build the headless Bitcoin Core binaries as well as the GUI (if Qt is found).
Configure and build the headless XPChain Core binaries as well as the GUI (if Qt is found).

You can disable the GUI build by passing `--without-gui` to configure.

Expand All @@ -67,30 +67,30 @@ Build Bitcoin Core
Running
-------

Bitcoin Core is now available at `./src/bitcoind`
XPChain Core is now available at `./src/xpchaind`

Before running, it's recommended that you create an RPC configuration file.

echo -e "rpcuser=bitcoinrpc\nrpcpassword=$(xxd -l 16 -p /dev/urandom)" > "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
echo -e "rpcuser=xpchainrpc\nrpcpassword=$(xxd -l 16 -p /dev/urandom)" > "/Users/${USER}/Library/Application Support/XPChain/xpchain.conf"

chmod 600 "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
chmod 600 "/Users/${USER}/Library/Application Support/XPChain/xpchain.conf"

The first time you run bitcoind, it will start downloading the blockchain. This process could take several hours.
The first time you run xpchaind, it will start downloading the blockchain. This process could take several hours.

You can monitor the download process by looking at the debug.log file:

tail -f $HOME/Library/Application\ Support/Bitcoin/debug.log
tail -f $HOME/Library/Application\ Support/XPChain/debug.log

Other commands:
-------

./src/bitcoind -daemon # Starts the bitcoin daemon.
./src/bitcoin-cli --help # Outputs a list of command-line options.
./src/bitcoin-cli help # Outputs a list of RPC commands when the daemon is running.
./src/xpchaind -daemon # Starts the xpchain daemon.
./src/xpchain-cli --help # Outputs a list of command-line options.
./src/xpchain-cli help # Outputs a list of RPC commands when the daemon is running.

Notes
-----

* Tested on OS X 10.10 Yosemite through macOS 10.13 High Sierra on 64-bit Intel processors only.

* Building with downloaded Qt binaries is not officially supported. See the notes in [#7714](https://github.com/bitcoin/bitcoin/issues/7714)
* Building with downloaded Qt binaries is not officially supported. See the notes in [#7714](https://github.com/xpchain/xpchain/issues/7714)
Loading