aboutsummaryrefslogtreecommitdiff
path: root/doc/README_doxygen.md
diff options
context:
space:
mode:
authorJon Layton <me@jonl.io>2019-09-18 18:54:20 -0400
committerJon Layton <me@jonl.io>2019-09-23 19:22:06 -0400
commitc15ac2c0aa45c59aee6d36c2d6d5210290dc601c (patch)
treef0fd042e440c5c307773f8a6aa06bd892660da7d /doc/README_doxygen.md
parent3ce829888861a6dc6a29da669584ada961d965fa (diff)
downloadbitcoin-c15ac2c0aa45c59aee6d36c2d6d5210290dc601c.tar.xz
doc: Move doxygen intro to file for USE_MDFILE_AS_MANPAGE
doc: Change header to notitle
Diffstat (limited to 'doc/README_doxygen.md')
-rw-r--r--doc/README_doxygen.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/README_doxygen.md b/doc/README_doxygen.md
new file mode 100644
index 0000000000..608680ad3e
--- /dev/null
+++ b/doc/README_doxygen.md
@@ -0,0 +1,15 @@
+\mainpage notitle
+
+\section intro_sec Introduction
+
+This is the developer documentation of the reference client for an experimental new digital currency called Bitcoin,
+which enables instant payments to anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate
+with no central authority: managing transactions and issuing money are carried out collectively by the network.
+
+The software is a community-driven open source project, released under the MIT license.
+
+See https://github.com/bitcoin/bitcoin and https://bitcoincore.org/ for further information about the project.
+
+\section Navigation
+Use the buttons <code>Namespaces</code>, <code>Classes</code> or <code>Files</code> at the top of the page to start navigating the code.
+