mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2024-11-20 10:38:42 +01:00
Code Issues Projects Releases Wiki Activity
04710b6d8c
bitcoin/doc
History
fanquake 04710b6d8c
Merge #15964: Docs: Improve build-osx document formatting 
dbd137a4ea Improve build-osx formatting (Giulio Lombardo)

Pull request description:

  This `PR` will improve `build-osx.md` formatting by:

  1. Updating Markdown syntax to the latest one
  2. Adding syntax highlighting to all code blocks
  3. Aligning the text up to `80` column guideline (before it was following different guidelines, sometime `80`, sometime `90`, etc.)
  4. Small grammar improvements here and there

ACKs for top commit:
  fanquake:
    ACK dbd137a4ea - Document reads and renders essentially the same as the current `build-osx.md`, with minor formatting / grammatical  changes.

Tree-SHA512: 47747991b5fddf0725c82f17f153e83150e51f698787544b4c51b32479989e4b550e2b3aec92979d2b0c76edfdcbbe7c4d9d0115df12e2bfde0cfcb277e9b984
2019-06-29 15:04:23 +08:00
..
man Remove -mempoolreplacement to prevent needless block prop slowness. 2019-06-08 09:32:33 -04:00
release-notes Fix spelling errors identified by codespell 1.15.0 2019-06-11 17:18:16 +02:00
.gitignore
assets-attribution.md
benchmarking.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
bips.md Update bips.md for 0.18.0 2019-04-06 08:37:07 -07:00
bitcoin_logo_doxygen.png
bitcoin-conf.md Add doc/bitcoin-conf.md 2018-10-19 01:13:57 +03:00
build-freebsd.md doc: update FreeBSD build guide for 12.0 2019-02-15 19:54:59 +08:00
build-netbsd.md doc: update NetBSD build instructions for 8.0 2018-12-13 12:05:45 +08:00
build-openbsd.md Merge #14515: doc: Update OpenBSD build guide for 6.4 2018-11-05 13:26:37 +01:00
build-osx.md Improve build-osx formatting 2019-06-14 13:50:12 +02:00
build-unix.md doc: Remove ppa from linux build instructions 2019-03-03 11:37:40 -05:00
build-windows.md Remove Windows 32 bit build 2019-05-03 13:41:27 -04:00
dependencies.md [depends] boost: update to 1.70 2019-05-03 13:22:17 +01:00
descriptors.md Mention new descriptor RPCs in descriptors.md 2019-04-06 08:17:51 -07:00
developer-notes.md doc: remove orphaned header in developer notes 2019-06-20 18:15:17 -04:00
dnsseed-policy.md
Doxyfile.in
files.md Add nice table to files.md 2018-12-11 22:24:09 +01:00
fuzzing.md qa: Add test/fuzz/test_runner.py 2019-02-13 17:12:28 -05:00
gitian-building.md
init.md init: Modify docs and add release note for 12255 2019-02-04 09:18:28 -05:00
JSON-RPC-interface.md doc: Clarify RPC versioning 2019-04-15 11:20:16 -04:00
productivity.md docs: Add productivity notes for "dummy rebases" 2019-05-15 14:12:45 -04:00
psbt.md doc: fix/improve analyzepsbt in doc/psbt.md 2019-05-19 17:31:37 +02:00
README_windows.txt
README.md travis: Properly cache and error on timeout 2019-04-05 13:35:27 -04:00
reduce-traffic.md doc: Mention blocksonly in reduce-traffic.md, unhide option 2019-05-13 10:44:46 -04:00
release-notes-13756.md docs: release note wording 2019-06-22 02:45:40 +09:00
release-notes-14054.md [docs] release note for disabling reject messages by default 2019-03-15 09:16:12 -04:00
release-notes-14802.md rpc: faster getblockstats using BlockUndo data 2019-05-10 08:33:14 -04:00
release-notes-14954.md docs: add release note for 14954 2019-05-28 14:17:31 -04:00
release-notes-15006.md Add option to create an encrypted wallet 2019-05-13 22:49:34 -04:00
release-notes-15566.md cli: replace testnet with chain and return network name as per BIP70. 2019-03-09 16:35:26 +08:00
release-notes-15620.md doc: Add release notes for 15620 2019-03-19 17:06:43 -04:00
release-notes-15637.md rpc: Rename size to vsize in mempool related calls 2019-03-24 12:01:43 +08:00
release-notes-15730.md doc: Add release notes for 15730 2019-05-02 11:39:07 +01:00
release-notes-15849.md threads: prefix log messages with thread names 2019-04-29 13:49:15 -04:00
release-notes.md doc: Add release notes for 14897 & 15834 2019-06-14 15:54:52 -04:00
release-process.md doc: Remove explicit mention of version from SECURITY.md 2019-06-14 06:39:17 -04:00
REST-interface.md rpc: Expose g_is_mempool_loaded via getmempoolinfo and /rest/mempool/info.json 2019-03-22 02:31:20 -07:00
shared-libraries.md doc: correct bitcoinconsensus_version in shared-libraries 2019-04-07 21:42:32 +08:00
tor.md doc: describe onlynet option in doc/tor.md 2019-04-11 14:05:02 +02:00
translation_process.md docs: Update Transifex links 2019-03-02 17:42:33 +08:00
translation_strings_policy.md A few textual improvements 2019-02-08 09:47:50 +01:00
zmq.md ZMQ: add options to configure outbound message high water mark, aka SNDHWM 2018-10-19 07:36:13 -04:00

README.md

Bitcoin 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 requires a few hundred gigabytes of disk space. 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.

Running

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

Unix

Unpack the files into a directory and run:

  • bin/bitcoin-qt (GUI) or
  • bin/bitcoind (headless)

Windows

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

macOS

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

Need Help?

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.

Development

The Bitcoin repo's root README contains relevant information on the development process and automated testing.

Resources

Miscellaneous

License

Distributed under the MIT software license. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. This product includes cryptographic software written by Eric Young (eay@cryptsoft.com), and UPnP software written by Thomas Bernard.