diff --git a/README.md b/README.md index a1e6bfc..d7f2021 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@ # tinychain -A mini blockchain implementation in C++14 +A mini blockchain implementation in C++14 构建迷你区块链——《深入浅出区块链》 -构建迷你区块链——《深入浅出区块链》 - -## 简要说明 Smmary +## 简要说明 INTRODUNCTION tinychain是一个业余的项目，旨在为大家提供微型的简单易懂的供学习的代码。 以下是涉及的一些基础技术： * 加密库 - RSA @@ -11,8 +9,9 @@ tinychain是一个业余的项目，旨在为大家提供微型的简单易懂 * P2P网络 - 暂定gossip * 网络文本协议 - JSON-RPC * HTTP Server - mongoose +* 正在选取中... -## toolchain +## 锻造工具 Toolchain * gcc/clang support C++14 * boost 1.56+ (datetime) * cmake @@ -20,7 +19,7 @@ tinychain是一个业余的项目，旨在为大家提供微型的简单易懂 * sqlite3 (apt-get install libsqlite3-dev / brew install sqlite3) * cryptopp (apt-get install libcryptopp-dev / brew install cryptopp) -## build +## 构建 Build On workpath of tinychain: ``` $ mkdir -p build && cd build @@ -36,7 +35,7 @@ Specifically, build on Windows (example): ``` Open tinychain.sln under build subfolder with Visual Studio to compile. -## run +## 运行 Run On workpath of tinychain: ``` $ cd build/bin @@ -52,15 +51,15 @@ Specifically, run on Windows (example): > tinychain.exe ``` -## 开发路径（TODO-LIST） +## 开发路径 TODO-LIST 1. 基础代码 - (DONE, to be improved) 1. PoW 挖矿代码 - (DONE, to be improved) 1. 加密与账户模型 (DOING) 1. P2P网络- (TODO) 1. 命令行与Web动态演示 - (DOING) -1. 共识可替换为PoS/DPoS etc - (TODO) +1. 共识可替换为PoS/DPoS/PBFT etc - (TODO) -## 仓库介绍 +## 仓库介绍 Source code view * cli-tinychain文件夹：命令行 * contrib文件夹：json与mongoose工具 * etc文件夹：tinychain演示网页等 diff --git a/contrib/README.md b/contrib/README.md index 8f3819a..89c1098 100644 --- a/contrib/README.md +++ b/contrib/README.md @@ -1 +1,8 @@ -open source code lib here +# tinychain +A mini blockchain implementation in C++14 构建迷你区块链——《深入浅出区块链》 + +## 说明 INTRODUNCTION +json - 废弃版本 +jsoncpp - 通过源代码集成的jsoncpp +mongoose - 通过源代码集成的开源微型嵌入式HTTP Server +sqlite - sqlite3官方接口 diff --git a/include/README.md b/include/README.md index 48830a4..41d01cd 100644 --- a/include/README.md +++ b/include/README.md @@ -1,2 +1,8 @@ -MODULES --------------- +# tinychain +A mini blockchain implementation in C++14 构建迷你区块链——《深入浅出区块链》 + +## 说明 INTRODUNCTION +metaverse - 从元界移植过来的代码，提供HTTP Wrapper +mgbubble.hpp - 元界部分的头文件包含 +sqlite3pp - 一个sqlite3的第三方C++11 wrapper +tinychain - 核心代码 diff --git a/include/tinychain/blockchain.hpp b/include/tinychain/blockchain.hpp index b313f33..5d0c6b2 100644 --- a/include/tinychain/blockchain.hpp +++ b/include/tinychain/blockchain.hpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #pragma once #include #include diff --git a/include/tinychain/commands.hpp b/include/tinychain/commands.hpp index 7a3fe6d..ba05a66 100644 --- a/include/tinychain/commands.hpp +++ b/include/tinychain/commands.hpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #pragma once #include #include diff --git a/include/tinychain/consensus.hpp b/include/tinychain/consensus.hpp index f6e146d..923a02f 100644 --- a/include/tinychain/consensus.hpp +++ b/include/tinychain/consensus.hpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #pragma once #include #include diff --git a/include/tinychain/database.hpp b/include/tinychain/database.hpp index 10880b2..f3db505 100644 --- a/include/tinychain/database.hpp +++ b/include/tinychain/database.hpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #pragma once #include #include diff --git a/include/tinychain/logging.hpp b/include/tinychain/logging.hpp index 8e24b3e..9e27e8b 100644 --- a/include/tinychain/logging.hpp +++ b/include/tinychain/logging.hpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ /** * Copyright (c) 2011-2015 libbitcoin developers (see AUTHORS) * Copyright (c) 2016-2018 metaverse core developers (see MVS-AUTHORS) diff --git a/include/tinychain/network.hpp b/include/tinychain/network.hpp index 68903d8..fb6bd4d 100644 --- a/include/tinychain/network.hpp +++ b/include/tinychain/network.hpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #pragma once #include diff --git a/include/tinychain/node.hpp b/include/tinychain/node.hpp index 6639ccd..1d69001 100644 --- a/include/tinychain/node.hpp +++ b/include/tinychain/node.hpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #pragma once #include #include diff --git a/include/tinychain/sha256.hpp b/include/tinychain/sha256.hpp index 2a05faf..224f95d 100644 --- a/include/tinychain/sha256.hpp +++ b/include/tinychain/sha256.hpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #pragma once #include diff --git a/include/tinychain/tinychain.hpp b/include/tinychain/tinychain.hpp index 20ca157..facd762 100644 --- a/include/tinychain/tinychain.hpp +++ b/include/tinychain/tinychain.hpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #pragma once #include diff --git a/src/blockchain.cpp b/src/blockchain.cpp index eab90e8..28af4a6 100644 --- a/src/blockchain.cpp +++ b/src/blockchain.cpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #include #include diff --git a/src/commands.cpp b/src/commands.cpp index f72ce63..2845099 100644 --- a/src/commands.cpp +++ b/src/commands.cpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #include #include diff --git a/src/consensus.cpp b/src/consensus.cpp index 8cb95d4..6daacb4 100644 --- a/src/consensus.cpp +++ b/src/consensus.cpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #include #include #include diff --git a/src/database.cpp b/src/database.cpp index 0a46ea4..5a4091d 100644 --- a/src/database.cpp +++ b/src/database.cpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #include #include diff --git a/src/main.cpp b/src/main.cpp index 18af17a..c8214a3 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #include #include #include diff --git a/src/network.cpp b/src/network.cpp index 8d20796..d782783 100644 --- a/src/network.cpp +++ b/src/network.cpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #include #include #include diff --git a/src/node.cpp b/src/node.cpp index f2dc0d6..b9576ce 100644 --- a/src/node.cpp +++ b/src/node.cpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #include #include diff --git a/src/tinychain.cpp b/src/tinychain.cpp index f17a3fb..21eac7c 100644 --- a/src/tinychain.cpp +++ b/src/tinychain.cpp @@ -1,3 +1,8 @@ +/** + * Part of: + * Comments: + * +**/ #include #include