dash/doc
fanquake f54ec9cde7 Merge bitcoin/bitcoin#21711: guix: Add full installation and usage documentation
fac4814106c796b8786dd90053513cc35142dfe5 doc/release-process: Add torrent creation details (Carl Dong)
5d24cc3d82dad6812f8370c3ccc7c2b5a6c12c11 guix/INSTALL: Guix installs init scripts in libdir (Carl Dong)
5da2ee49d5b44de803b671aedbdd14e5c1d71ea9 guix/INSTALL: Add coreutils/inotify-dir-recreate troubleshooting (Carl Dong)
318c60700b7bbb7ec09a29bf037e7c2787646be6 guix: Adapt release-process.md to new Guix process (Carl Dong)
fcab35b2292f9221eaba521740e8b3b2511a8b78 guix-attest: Produce and sign normalized documents (Carl Dong)
c2541fd0ca99481a5a792a8f2772925d64fb0491 guix: Overhaul README (Carl Dong)
46ce6ce3782dfbd8f9d26dc2ba0f284755e75f2d tree-wide: Rename gitian-keys to builder-keys (Carl Dong)
fc4f8449f34e32b0b9ac9d218d6c3264b02467ba guix: Update various check_tools lists (Carl Dong)
263220a85c1df218431fafbda07c8b23ccc4ce4d guix: Check for a sane services database (Carl Dong)

Pull request description:

  Based on: #21462

  Keeping the README in one file so that it's easy to search through. Will add more jumping links later so navigation is easier.

  Current TODOs:
  - [x] Shell installer option: prompt user to re-login for `/etc/profile.d` entry to be picked up
  - [x] Binary tarball option: prompt user to create `/etc/profile.d` entry and re-login
  - [x] Fanquake docker option: complete section
  - [x] Arch Linux AUR option: prompt to start `guix-daemon-latest` unit after finishing "optional setup" section
  - [x] Building from source option: Insert dependency tree diagram that I made
  - [x] Building from source option: redo sectioning, kind of a mess right now
  - [x] Optional setup: make clear which parts are only needed if building from source
  - [x] Workaround 1 for GnuTLS: perhaps mention how to remove Guix build farm's key
  - [x] Overall (after everything): Make the links work.

  Note to self: wherever possible, tell user how to check that something is true rather than branching by installation option.

ACKs for top commit:
  fanquake:
    ACK fac4814106c796b8786dd90053513cc35142dfe5 - going to go ahead and merge this now. It's a lot of documentation, and could probably be nit-picked / improved further, however, that can continue over the next few weeks. I'm sure more (backportable) improvements / clarifications will be made while we progress through RCs towards a new release.

Tree-SHA512: dc46c0ecdfc67c7c7743ca26e4a603eb3f54adbf81be2f4c1f4c20577ebb84b5250b9c9ec89c0e9860337ab1c7cff94d7963c603287267deecfe1cd987fa070a
2023-04-15 12:13:27 -05:00
..
gitian-building
man chore: run gen-manpages.sh for 19.0.0 (#5305) 2023-04-09 21:48:23 -05:00
release-notes/dash doc: update the content of release notes for v19.0.0 and archive old release notes 2023-04-11 12:41:13 -05:00
.gitignore
assets-attribution.md
benchmarking.md Merge #17081: doc: fix Makefile target in benchmarking.md 2022-05-17 01:20:21 -04:00
bips.md merge bitcoin#15437: Remove BIP61 reject messages 2022-12-02 15:43:01 +05:30
bitcoin_logo_doxygen.png
build-cross.md docs: replace remaining OSX references with macOS 2023-01-01 20:42:09 -06:00
build-generic.md merge bitcoin#10779: Create dependencies.md 2023-01-01 20:42:09 -06:00
build-netbsd.md
build-osx.md partial bitcoin#19077: Add sqlite as an alternative wallet database and use it for new descriptor wallets 2023-02-07 10:53:33 -06:00
build-unix.md Merge #16643: doc: Add ZMQ dependencies to the Fedora build instructions 2023-04-04 12:45:27 -05:00
build-windows.md
dash-conf.md
dependencies.md Merge #16352: build: prune dbus from depends 2023-03-29 21:01:56 +03:00
descriptors.md Merge #18032: rpc: Output a descriptor in createmultisig and addmultisigaddress 2023-04-06 20:15:47 +03:00
developer-notes.md merge bitcoin#21404: Remove MakeUnique<T>() 2022-10-20 16:08:45 -05:00
dnsseed-policy.md
Doxyfile.in Merge bitcoin/bitcoin#22001: doc: Generate doxygen documentation for test sources 2022-03-13 14:52:10 -05:00
files.md Merge #20152: doc: Update wallet files in files.md 2023-04-09 00:06:56 -05:00
fuzzing.md Merge #19452: doc: afl fuzzing comment about afl-gcc and afl-g++ 2023-01-23 11:21:05 -06:00
gitian-building.md
guix.md Merge #20619: guix: Quality of life improvements 2023-03-26 16:50:26 -05:00
init.md Merge #16556: Fix systemd service file configuration directory setup 2023-04-06 20:14:58 +03:00
instantsend.md
JSON-RPC-interface.md
masternode-budget.md
productivity.md Merge #18382: doc: note the costs of fetching all pull requests 2022-04-07 07:22:27 +05:30
psbt.md Merge #16047: doc: analyzepsbt description in doc/psbt.md 2023-02-10 23:34:57 +03:00
README_doxygen.md
README_windows.txt
README.md Merge #15693: travis: Switch to ubuntu keyserver to avoid timeouts 2023-04-06 20:14:58 +03:00
reduce-memory.md Merge bitcoin/bitcoin#21709: doc: update reduce-memory.md and bitcoin.conf -maxconnections info 2022-04-05 23:10:05 -05:00
reduce-traffic.md Merge #19474: doc: Use precise permission flags where possible 2023-01-19 23:37:39 -06:00
release-notes-5225.md doc: update the content of release notes for v19.0.0 and archive old release notes 2023-04-11 12:41:13 -05:00
release-notes-5273.md doc: update the content of release notes for v19.0.0 and archive old release notes 2023-04-11 12:41:13 -05:00
release-notes-16185.md Merge #16873: rpc: fix regression in gettransaction 2023-04-06 20:14:58 +03:00
release-notes-17056.md Merge #17056: descriptors: Introduce sortedmulti descriptor 2023-04-06 20:15:47 +03:00
release-notes-18466.md Merge #18466: rpc: fix invalid parameter error codes for {sign,verify}message RPCs 2023-04-09 00:06:56 -05:00
release-notes-18733.md Merge #18733: doc: Add wallet release notes for 0.21.0 2023-03-03 23:07:16 +05:30
release-notes-18807.md Merge #18807: [doc / test / mempool] unbroadcast follow-ups 2023-02-27 23:12:41 -06:00
release-notes.md doc: update the content of release notes for v19.0.0 and archive old release notes 2023-04-11 12:41:13 -05:00
release-process.md Merge bitcoin/bitcoin#21711: guix: Add full installation and usage documentation 2023-04-15 12:13:27 -05:00
REST-interface.md Merge #17285: doc: Bip70 removal follow-up 2022-04-27 21:08:36 +03:00
shared-libraries.md revert dash#1432: Rename consensus source library and API 2022-08-09 14:16:28 +05:30
tor.md
translation_process.md
translation_strings_policy.md Merge #16224: gui: Bilingual GUI error messages 2022-04-07 10:41:24 -05:00
zmq.md

Dash Core

This is the official reference wallet for Dash digital currency and comprises the backbone of the Dash peer-to-peer network. You can download Dash Core or build it yourself using the guides below.

Running

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

Unix

Unpack the files into a directory and run:

  • bin/dash-qt (GUI) or
  • bin/dashd (headless)

Windows

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

macOS

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

Need Help?

Building

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

Development

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

Resources

Miscellaneous

License

Distributed under the MIT software license.