Forráskód Böngészése

add project description to docs

Malte Kraus 8 éve
szülő
commit
e08ac760d7
2 módosított fájl, 3 hozzáadás és 2 törlés
  1. 2 2
      doc/conf.py
  2. 1 0
      doc/index.rst

+ 2 - 2
doc/conf.py

@@ -57,8 +57,8 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'blockchain'
-copyright = u'2017, blockchain authors'
-author = u'blockchain authors'
+copyright = u'2017 Jonas Herzig, Malte Kraus'
+author = u'Jonas Herzig, Malte Kraus'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

+ 1 - 0
doc/index.rst

@@ -6,6 +6,7 @@
 Welcome to blockchain's documentation!
 ======================================
 
+This project is a completely new blockchain-based coin, with P2P networking, a consensus mechanism and a wallet interface. The goal of the project is to provide a framework that is easy to modify for people who want to develop proof-of-concepts for blockchain-based technology.
 
 Executables
 ***********