LBRYCommunity/lbrycrd
1
0
Fork 0
Code Issues 29 Pull requests 1 Packages Projects Releases 32 Wiki Activity
lbrycrd/doc
History
Wladimir J. van der Laan 5049f7f7a9
Merge #14625: Make clear function argument case in dev notes 
9605bbd315 Make clear function argument case in dev notes (Carl Dong)

Pull request description:

  Rationale:

  For new developers, they might be confused if they see that function arguments are sometimes `camelCase`'d in the codebase. This makes it clear that they _should_ be `snake_case`'d (maybe because no one's gotten to fixing them yet).

Tree-SHA512: 9db16d1fedf9761121844a0865ae3fefea94b5dbdfb36cb18f99cbc73e117f7d798a019f28a1c8bca19772502de2f9ed063f03bd911ffc4d248ec7386cd87d97
2018-11-01 16:31:08 +01:00
..
man configure: Make it possible to build only one of bitcoin-cli or bitcoin-tx 2018-09-13 11:48:23 +00:00
release-notes [docs] path to descriptors.md fixed 2018-10-07 11:16:22 +09: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 trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
bips.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
bitcoin-conf.md Add doc/bitcoin-conf.md 2018-10-19 01:13:57 +03:00
bitcoin_logo_doxygen.png Lossless image optimization 2013-12-02 10:10:22 +01:00
build-freebsd.md FreeBSD: Document Python 3 requirement for 'gmake check' 2018-10-31 02:52:50 -07:00
build-netbsd.md [doc] Create build-netbsd.md 2018-01-30 07:47:27 +08:00
build-openbsd.md Various textual improvements in build docs 2018-10-28 06:01:01 +01:00
build-osx.md Various textual improvements in build docs 2018-10-28 06:01:01 +01:00
build-unix.md Various textual improvements in build docs 2018-10-28 06:01:01 +01:00
build-windows.md Various textual improvements in build docs 2018-10-28 06:01:01 +01:00
dependencies.md [depends, zmq, doc] upgrade zeromq to 4.2.5 and avoid deprecated zeromq api functions 2018-09-11 16:33:05 -04:00
descriptors.md Update documentation to incude origin information 2018-10-20 20:31:19 -07:00
developer-notes.md Make clear function argument case in dev notes 2018-10-31 17:21:41 -07: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 [doc] Include txindex changes in the release notes. 2018-04-25 11:25:19 -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 doc: move gitian building to external repo 2017-09-25 15:45:38 +02:00
init.md Fix typos 2018-10-04 21:58:24 +03:00
JSON-RPC-interface.md doc: Add external interface consistency guarantees 2018-10-30 16:40:36 -04:00
psbt.md Add PSBT documentation 2018-08-14 12:13:42 -07:00
README.md doc: Add external interface consistency guarantees 2018-10-30 16:40:36 -04:00
README_osx.md Rename “OS X” to the newer “macOS” convention 2018-06-04 13:04:04 +02:00
README_windows.txt doc: Remove version numbers from READMEs 2017-04-05 09:40:48 +02:00
reduce-traffic.md trivial: Fixed typos and cleaned up language 2018-08-02 21:27:16 +08:00
release-notes-13152.md docs: Add release notes for listwalletdir RPC 2018-10-18 23:26:06 +01:00
release-notes-14023.md [wallet] Kill accounts 2018-08-30 16:08:42 +02:00
release-notes-14282.md [docs] Add release notes for removing -usehd 2018-09-26 17:32:39 -04:00
release-notes-14296.md [docs] Add release note for removing getwitnessaddress 2018-10-17 15:00:50 -04:00
release-notes-14454.md Add release notes for importmulti segwit change 2018-10-25 09:30:57 +13:00
release-notes-14468.md [wallet] Deprecate the generate RPC method 2018-10-18 17:46:48 -04:00
release-notes.md doc: release notes for -enablebip61 default change 2018-09-09 13:54:18 -04:00
release-process.md doc: RPC documentation 2018-10-04 16:43:10 +09:00
REST-interface.md doc: Add external interface consistency guarantees 2018-10-30 16:40:36 -04:00
shared-libraries.md Add NULLDUMMY verify flag in bitcoinconsensus.h 2016-09-30 23:09:19 +08:00
tor.md added note that control port must be enabled and how to do that in torrc config file 2018-08-31 07:50:55 -06:00
translation_process.md Docs: Improve "of" grammar 2018-08-03 02:49:48 +08:00
translation_strings_policy.md Docs: Modify policy to not translate command-line help 2018-07-04 09:18:29 +08:00
travis-ci.md [doc] Rework docs 2016-10-04 13:27:38 +02:00
zmq.md [depends, zmq, doc] upgrade zeromq to 4.2.5 and avoid deprecated zeromq api functions 2018-09-11 16:33:05 -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.