README.md
1Namecoin Core
2==============
3
4Setup
5---------------------
6[Namecoin Core](http://namecoin.org/) is the official Namecoin client and it builds the backbone of the network. However, it downloads and stores the entire history of Namecoin 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.
7
8To download Namecoin Core, visit [namecoin.org](https://namecoin.org/download/).
9
10Running
11---------------------
12The following are some helpful notes on how to run Namecoin Core on your native platform.
13
14### Unix
15
16Unpack the files into a directory and run:
17
18- `bin/namecoin-qt` (GUI) or
19- `bin/namecoind` (headless)
20
21### Windows
22
23Unpack the files into a directory, and then run namecoin-qt.exe.
24
25### macOS
26
27Drag Namecoin-Qt to your applications folder, and then run Namecoin-Qt.
28
29### Need Help?
30
31* See the documentation at the [Namecoin Site](https://namecoin.org)
32for help and more information.
33* Ask for help on [#namecoin](http://webchat.freenode.net?channels=namecoin) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net?channels=namecoin).
34* Ask for help on the [Namecoin forums](https://forum.namecoin.info/index.php), in the [Technical Support board](https://forum.namecoin.info/viewforum.php?f=7).
35
36Building
37---------------------
38The 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.
39
40- [Dependencies](dependencies.md)
41- [macOS Build Notes](build-osx.md)
42- [Unix Build Notes](build-unix.md)
43- [Windows Build Notes](build-windows.md)
44- [FreeBSD Build Notes](build-freebsd.md)
45- [OpenBSD Build Notes](build-openbsd.md)
46- [NetBSD Build Notes](build-netbsd.md)
47- [Gitian Building Guide (External Link)](https://github.com/bitcoin-core/docs/blob/master/gitian-building.md)
48
49Development
50---------------------
51The Namecoin repo's [root README](https://github.com/namecoin/namecore/blob/master/README.md) contains relevant information on the development process and automated testing.
52
53- [Developer Notes](developer-notes.md)
54- [Productivity Notes](productivity.md)
55- [Release Notes](release-notes.md)
56- [Release Process](release-process.md)
57- [Source Code Documentation (External Link)](https://doxygen.bitcoincore.org/)
58- [Translation Process](translation_process.md)
59- [Translation Strings Policy](translation_strings_policy.md)
60- [JSON-RPC Interface](JSON-RPC-interface.md)
61- [Unauthenticated REST Interface](REST-interface.md)
62- [Shared Libraries](shared-libraries.md)
63- [BIPS](bips.md)
64- [Dnsseed Policy](dnsseed-policy.md)
65- [Benchmarking](benchmarking.md)
66
67### Resources
68* Discuss on the [Namecoin forums](https://forum.namecoin.info/), in the [Development & Technical Discussion board](https://forum.namecoin.info/viewforum.php?f=8).
69* Discuss on [#namecoin-dev](http://webchat.freenode.net/?channels=namecoin-dev) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net/?channels=namecoin-dev).
70
71### Miscellaneous
72- [Assets Attribution](assets-attribution.md)
73- [bitcoin.conf Configuration File](bitcoin-conf.md)
74- [Files](files.md)
75- [Fuzz-testing](fuzzing.md)
76- [Reduce Memory](reduce-memory.md)
77- [Reduce Traffic](reduce-traffic.md)
78- [Tor Support](tor.md)
79- [Init Scripts (systemd/upstart/openrc)](init.md)
80- [ZMQ](zmq.md)
81- [PSBT support](psbt.md)
82
83License
84---------------------
85Distributed under the [MIT software license](/COPYING).
86
README_doxygen.md
1\mainpage notitle
2
3\section intro_sec Introduction
4
5This is the developer documentation of the reference client for an experimental new digital currency called Bitcoin,
6which enables instant payments to anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate
7with no central authority: managing transactions and issuing money are carried out collectively by the network.
8
9The software is a community-driven open source project, released under the MIT license.
10
11See https://github.com/bitcoin/bitcoin and https://bitcoincore.org/ for further information about the project.
12
13\section Navigation
14Use <a href="modules.html"><code>Modules</code></a>, <a href="namespaces.html"><code>Namespaces</code></a>, <a href="classes.html"><code>Classes</code></a>, or <a href="files.html"><code>Files</code></a> at the top of the page to start navigating the code.
15
16