dogecoin/doc/README.md

79 lines
3.3 KiB
Markdown
Raw Normal View History

2014-05-18 23:28:47 +02:00
Dogecoin 1.7.2 ALPHA
====================
2013-05-20 06:30:00 +02:00
2014-04-21 23:18:17 +02:00
* Copyright (c) 2009-2014 Bitcoin Developers
* Copyright (c) 2011-2013 Litecoin Developers
* Copyright (c) 2013-2014 Dogecoin Developers
2013-05-20 06:30:00 +02:00
Setup
---------------------
[Dogecoin Core](http://dogecoin.com/en/download) is the original Dogecoin client and it builds the backbone of the network. However, it downloads and stores the entire history of Dogecoin transactions (which is currently several 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. Thankfully you only have to do this once. If you would like the process to go faster you can [download the blockchain directly](bootstrap.md)
Running
---------------------
The following are some helpful notes on how to run Dogecoin on your native platform.
### Unix
You need the Qt4 run-time libraries to run Dogecoin-Qt. On Debian or Ubuntu:
sudo apt-get install libqtgui4
2013-05-20 06:30:00 +02:00
Unpack the files into a directory and run:
- bin/32/dogecoin-qt (GUI, 32-bit) or bin/32/dogecoind (headless, 32-bit)
- bin/64/dogecoin-qt (GUI, 64-bit) or bin/64/dogecoind (headless, 64-bit)
2013-05-20 06:30:00 +02:00
### Windows
Unpack the files into a directory, and then run dogecoin-qt.exe.
### OSX
Drag Dogecoin-Qt to your applications folder, and then run Dogecoin-Qt.
### Need Help?
* See the documentation at the [Dogecoin Wiki](http://dogeco.in/)
for help and more information.
* Ask for help on [#dogecoin](http://webchat.freenode.net?channels=dogecoin) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net?channels=dogecoin).
* Ask for help on the [/r/dogeducation subreddit](http://reddit.com/r/dogeducation).
Building
2013-05-20 06:30:00 +02:00
---------------------
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.
2013-05-20 06:30:00 +02:00
- [OSX Build Notes](build-osx.md)
- [Unix Build Notes](build-unix.md)
2013-05-20 06:30:00 +02:00
- [Windows Build Notes](build-msw.md)
Development
---------------------
The Dogecoin repo's [root README](https://github.com/dogecoin/dogecoin/blob/master/README.md) contains relevant information on the development process and automated testing.
2013-05-20 06:30:00 +02:00
- [Coding Guidelines](coding.md)
- [Multiwallet Qt Development](multiwallet-qt.md)
- [Release Notes](release-notes.md)
- [Release Process](release-process.md)
- [Source Code Documentation (External Link)](https://dev.visucore.com/bitcoin/doxygen/)
- [Translation Process](translation_process.md)
2013-05-20 06:30:00 +02:00
- [Unit Tests](unit-tests.md)
### Resources
2014-04-21 23:18:17 +02:00
* Discuss on the [/r/dogecoindev](http://www.reddit.com/r/dogecoindev) subreddit.
* Discuss on [#dogecoin-dev](http://webchat.freenode.net/?channels=dogecoin-dev) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net/?channels=dogecoin-dev).
### Miscellaneous
- [Assets Attribution](assets-attribution.md)
- [Files](files.md)
- [Tor Support](tor.md)
License
---------------------
Distributed under the [MIT/X11 software license](http://www.opensource.org/licenses/mit-license.php).
This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](http://www.openssl.org/). This product includes
cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard.