From 67a0b0363de4137fad099ae3daf925876e8dc7ab Mon Sep 17 00:00:00 2001 From: Patrick Lodder Date: Fri, 20 Aug 2021 02:55:29 +0200 Subject: [PATCH] fixup installation guide --- INSTALL.md | 58 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 37 insertions(+), 21 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 1f4119ab7..51fb2dc2c 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,35 +1,51 @@ -# Building Dogecoin Core +# Installing Dogecoin Core -Development is ongoing, and the development team, as well as other volunteers, -can freely work in their own trees and submit pull requests when features or -bug fixes are ready. +### Pre-compiled binaries -### Wow plz make dogecoind/dogecoin-cli/dogecoin-qt +The easiest way to install the latest version of the Dogecoin Core software is +by to download the latest precompiled binaries for your platform from the +[release page](https://github.com/dogecoin/dogecoin/releases). Currently, +binaries are released for the following platforms: - The following are developer notes on how to build Dogecoin on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc. +- Windows, 64-bit and 32-bit +- Linux, 64-bit and 32-bit +- MacOS, Intel 64-bit +- ARM, 64-bit and 32-bit Linux + +These binaries are created and verified by multiple independent people, to +ensure honest and malware-free releases. See +[the gitian building documentation](doc/gitian-building.md) for more information +regarding that process. + +### Compiling using packaged dependencies + +It is possible to build your own copy of Dogecoin Core with the exact, tested, +dependencies, as used for the binary releases, by using the +[depends system](depends/description.md). Please refer to the +[depends README](depends/README.md) for instructions to build Dogecoin using +these dependencies. + +### Compiling using system-provided libraries + + The following are developer notes on how to build Dogecoin on your native + platform, using the dependencies as provided by your system's package manager. + They are not complete guides, but include notes on the necessary libraries, + compile flags, etc. - - [OSX Build Notes](doc/build-osx.md) - [Unix Build Notes](doc/build-unix.md) - [Windows Build Notes](doc/build-windows.md) + - [macOS Build Notes](doc/Building-Dogecoin-1.14-for-Mac.md) -#### Contributions ✍️ +### Testing -Developers are strongly encouraged to write [unit tests](src/test/README.md) for new code, and to -submit new unit tests for old code. Unit tests can be compiled and run -(assuming they weren't disabled in configure) with: `make check`. Further details on running +Unit tests can be compiled and ran with `make check`. Further details on running and extending unit tests can be found in [/src/test/README.md](/src/test/README.md). -There are also [regression and integration tests](/qa) of the RPC interface, written -in Python, that are run automatically on the build server. -These tests can be run (if the [test dependencies](/qa) are installed) with: `qa/pull-tester/rpc-tests.py` +There are also [regression and integration tests](/qa) written in Python, that +are run automatically on the build server. These tests can be run (if the +[test dependencies](/qa) are installed) with: `qa/pull-tester/rpc-tests.py` -Changes should be tested by somebody other than the developer who wrote the -code. This is especially important for large or high-risk changes. It is useful -to add a test plan to the pull request description if testing the changes is -not straightforward. - - -## Development tips and tricks +### Tips and tricks **compiling for debugging**