Skip to content

documentation #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 20 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions DApp-Dev-Guid.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
==================
DApp-Dev-Guid
==================

How to develop a block explorer
=================================

152525

How to develop a game on blockchain
=====================================

14552



How to develop a web based wallet
=======================================

415252154
369 changes: 369 additions & 0 deletions DApp-Dev-Reference.rst

Large diffs are not rendered by default.

44 changes: 44 additions & 0 deletions Installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@

======================
Installation
======================

How to setup the testnet-node service
======================================
something here..


How to setup the blockexplorer
=================================
something here ..

How to setup the faucet-wallet
================================
something there


How to setup the web-based game
==================================
somethig here


How to create an account and get some tokens
==============================================
something here

How to create a token (technical)
=========================================
something here


How to issue a toekn (non-technical)
=====================================
something here


How to create an DApp on Bitconch mainnet(technical)
======================================================
something here



64 changes: 64 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = 'Bitconch'
copyright = '2019, cc'
author = 'Caesar Chad'

# The full version, including alpha/beta/rc tags
release = '1.2'


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'zh_CN'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
#html_static_path = ['_static']
20 changes: 13 additions & 7 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,15 @@ Bitconch

.. image:: logo.svg
:width: 120px
:alt: Solidity logo
:alt: Bitconch logo
:align: center

Something about Bitconch
With 100000 TPSs, Bitconch is the fastest basic public chain in the world,
dedicated to building a truly decentralized network and infrastructure for it.
Based on the orginal POR reputation consensus algorithm, Bitconch develops
Bit-R reputation quantification anti-centralization node governance system
and Blaze zero delay ledger access technology, which effectively solves the
incompatibility of "high speed, security and decentralization".

.. warning::

Expand All @@ -27,9 +32,9 @@ Language Documentation
:ref:`security_considerations` section.

If you have any questions, you can try searching for answers or asking on the
`Ethereum Stackexchange <https://ethereum.stackexchange.com/>`_, or our `gitter channel <https://gitter.im/ethereum/solidity/>`_.
`Bitconch Documentation <https://github.com/bitconch/Documentation>`_, or our `Technical Manual <https://bitconch.io/technicalManual.jhtml>`_.

Ideas for improving Solidity or this documentation are always welcome, read our :doc:`contributors guide <contributing>` for more details.
Ideas for improving Bitconch or this documentation are always welcome, read our :doc:`contributors guide <contributing>` for more details.

.. _translations:

Expand All @@ -41,7 +46,7 @@ They have varying degrees of completeness and up-to-dateness. The English
version stands as a reference.

* `Simplified Chinese <http://bitconch-zn.readthedocs.io>`_ (in progress)
* `Korean <http://bitconch-kr.readthedocs.io>`_ (in progress)
* `English <http://bitconch-kr.readthedocs.io>`_ (in progress)


Contents
Expand All @@ -51,5 +56,6 @@ Contents

.. toctree::
:maxdepth: 2
How-to-setup-the-testnet-node-service.rst
How-to-setup-the-blockexplorer.rst
Installation.rst
DApp-Dev-Guid.rst
DApp-Dev-Reference.rst
Loading