mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2024-11-19 18:09:47 +01:00
Code Issues Projects Releases Wiki Activity
c58128f189
bitcoin/doc
History
Wladimir J. van der Laan c58128f189
Merge #10878: Docs: Fix Markdown formatting issues in init.md 
d201e40 Update init.md: Fix section numbering. (Carl Dong)
72a184a Update init.md: Fix line breaks in section 3b. (Carl Dong)

Pull request description:

  Trivial commit that fixes Markdown line breaks in `docs/init.md`. Markdown line breaks take the form of two spaces, which is hard to spot when viewing raw text but visible when previewing on GitHub. Line 72-73 of `docs/init.md` did not conform to the rest the rest of the documentation, and is corrected in this PR.

Tree-SHA512: e5f048bd4e9e1e68372c95881f68b157a3c205d4dbcc6ccd24f2c0171b84d8cf7907d1835c6754ce57f35f9463820353ad7ae70c2e3de20136382ea3ee8bc4ff
2017-08-18 09:56:51 +02:00
..
gitian-building Add instructions for multi-processor gitian builds 2017-08-13 12:26:04 +02:00
man Merge #9892: Bugfix: Only install manpages for built programs 2017-03-01 12:33:38 +01:00
release-notes doc: Add 0.14.2 release notes 2017-06-18 10:36:54 +02:00
.gitignore Ignore Doxyfile generated from Doxyfile.in template. 2017-04-07 16:28:12 +02:00
assets-attribution.md [doc] Merge doc/assets-attribution.md into contrib/debian/copyright 2015-09-18 18:14:42 +02:00
benchmarking.md [Doc] Add benchmarking notes 2016-05-29 17:56:34 +08:00
bips.md [doc] Update doc/bips.md for BIP90 implementation 2017-02-27 12:21:40 -05:00
bitcoin_logo_doxygen.png
build-openbsd.md Update OpenBSD and FreeBSD build steps 2017-02-07 13:01:41 +01:00
build-osx.md [doc] Minor corrections to osx dependencies 2017-04-23 08:47:44 +08:00
build-unix.md Minor fix in build documentation for FreeBSD 11 2017-04-21 10:09:10 +09:00
build-windows.md Update the Windows build notes 2016-12-29 23:54:14 -08:00
developer-notes.md Prefer compile-time checking over run-time checking 2017-08-17 00:42:32 +02:00
dnsseed-policy.md Correct spelling mistakes in doc folder 2015-10-18 06:25:43 +10:00
Doxyfile.in doc: Make build system insert version in Doxyfile 2017-04-05 09:40:56 +02:00
files.md Add mempool.dat to doc/files.md 2016-10-31 00:10:36 -07:00
fuzzing.md [test] Speed up fuzzing by ~200x when using afl-fuzz 2017-05-19 07:28:46 +02:00
gitian-building.md Add instructions for multi-processor gitian builds 2017-08-13 12:26:04 +02:00
init.md Update init.md: Fix section numbering. 2017-07-29 00:20:43 +08:00
README_osx.md Merge #8617: Include instructions to extract Mac OS X SDK on Linux using 7zip and SleuthKit 2016-08-29 16:17:36 +02:00
README_windows.txt doc: Remove version numbers from READMEs 2017-04-05 09:40:48 +02:00
README.md doc: Remove version numbers from READMEs 2017-04-05 09:40:48 +02:00
reduce-traffic.md Remove maxuploadtargets recommended minimum 2016-09-13 18:08:17 +02:00
release-notes.md build: bump version to 0.15.99 2017-08-14 17:28:30 +02:00
release-process.md Add instructions for multi-processor gitian builds 2017-08-13 12:26:04 +02:00
REST-interface.md Merge #10680: Fix inconsistencies and grammar in various files 2017-08-16 00:46:40 +02:00
shared-libraries.md Add NULLDUMMY verify flag in bitcoinconsensus.h 2016-09-30 23:09:19 +08:00
tor.md Clarify listenonion 2016-10-24 15:49:46 +08:00
translation_process.md Fix typo and spelling inconsistency in CONTRIBUTING.md 2017-02-09 11:56:44 +09:00
translation_strings_policy.md Init: Cleanup error and warning strings 2015-10-28 22:11:43 +01:00
travis-ci.md [doc] Rework docs 2016-10-04 13:27:38 +02:00
zmq.md Fix typo and spelling inconsistency in CONTRIBUTING.md 2017-02-09 11:56:44 +09: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 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.

Running

The following are some helpful notes on how to run Bitcoin 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.

OS X

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 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.