fixup installation guide
This commit is contained in:
parent
197104536a
commit
67a0b0363d
58
INSTALL.md
58
INSTALL.md
|
@ -1,35 +1,51 @@
|
||||||
# Building Dogecoin Core
|
# Installing Dogecoin Core
|
||||||
|
|
||||||
Development is ongoing, and the development team, as well as other volunteers,
|
### Pre-compiled binaries
|
||||||
can freely work in their own trees and submit pull requests when features or
|
|
||||||
bug fixes are ready.
|
|
||||||
|
|
||||||
### 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)
|
- [Unix Build Notes](doc/build-unix.md)
|
||||||
- [Windows Build Notes](doc/build-windows.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
|
Unit tests can be compiled and ran with `make check`. Further details on running
|
||||||
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
|
|
||||||
and extending unit tests can be found in [/src/test/README.md](/src/test/README.md).
|
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
|
There are also [regression and integration tests](/qa) written in Python, that
|
||||||
in Python, that are run automatically on the build server.
|
are run automatically on the build server. These tests can be run (if the
|
||||||
These tests can be run (if the [test dependencies](/qa) are installed) with: `qa/pull-tester/rpc-tests.py`
|
[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
|
### Tips and tricks
|
||||||
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
|
|
||||||
|
|
||||||
**compiling for debugging**
|
**compiling for debugging**
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue