Skip to content

Commit

Permalink
<doc>(README): update README and README_CN. (#542)
Browse files Browse the repository at this point in the history
  • Loading branch information
kyonRay authored Dec 10, 2021
1 parent 2b02b4f commit 4898dd6
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 17 deletions.
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,39 +9,34 @@ English / [中文](doc/README_CN.md)
[![GitHub All Releases](https://img.shields.io/github/downloads/FISCO-BCOS/console/total.svg)](https://github.com/FISCO-BCOS/console)
---

The console is an important interactive client tool of [FISCO BCOS 2.0+](https://fisco-bcos-documentation.readthedocs.io/en/latest/). The console has a wealth of commands, including querying blockchain status, managing blockchain nodes, deploying and invoking contracts.
The console is an important interactive client tool of [FISCO BCOS 3.0+](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/). The console has a wealth of commands, including querying blockchain status, managing blockchain nodes, deploying and invoking contracts.

## Features

- Provide a lot of query commands for blockchain.
- Provide the easiest way to deploy and invoke contracts.
- Provide some commands which can manage blockchain node.
- Providea a contract compilation tool that allows users to easily and quickly compile Solidity contract files into Java contract files.
- Provide a contract compilation tool that allows users to easily and quickly compile Solidity contract files into Java contract files.
- Provide an easy way to transfer compiled Liquid contract material, such as WASM and ABI, into Java contract files.

## Usage

- You can download a tar file and decompress it to enjoy console. See [console manual](https://fisco-bcos-documentation.readthedocs.io/en/latest/docs/manual/console_of_java_sdk.html) for more details.
- You can download a tar file and decompress it to enjoy console. See [console manual](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/develop/console/index.html) for more details.

## Source Installation
```
$ git clone https://github.com/FISCO-BCOS/console.git
$ cd console
$ ./gradlew build
$ bash gradlew build
```

If you want to use sm crypto, and use hardware secure module, you can install with following commands.
```
$ git clone https://github.com/FISCO-BCOS/console.git
$ cd console
$ ./gradlew build -b build-hsm.gradle
```
If you install successfully, it produces the `dist` directory.

## Configuration
Please see the [documentation](https://fisco-bcos-documentation.readthedocs.io/en/latest/docs/manual/console_of_java_sdk.html#id8) about configurating for the console. Have fun.
Please see the [documentation](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/develop/console/console_config.html) about configuration for the console. Have fun :)

## Code Contribution
- Star our Github.
- Star our GitHub.
- Pull requests. See [CONTRIBUTING](CONTRIBUTING.md).
- [Ask questions](https://github.com/FISCO-BCOS/console/issues).

Expand All @@ -56,5 +51,4 @@ The FISCO BCOS community is one of the most active open-source blockchain commun
![license](https://img.shields.io/badge/license-Apache%20v2-blue.svg)



All contributions are made under the [Apache License 2.0](http://www.apache.org/licenses/). See [LICENSE](LICENSE).
9 changes: 5 additions & 4 deletions doc/README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,29 @@
[![GitHub All Releases](https://img.shields.io/github/downloads/FISCO-BCOS/console/total.svg)](https://github.com/FISCO-BCOS/console)
---

控制台是[FISCO BCOS 2.0+](https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/)的重要交互式客户端工具。控制台拥有丰富的命令,包括查询区块链状态、管理区块链节点、部署并调用合约等。
控制台是[FISCO BCOS 3.0+](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/)的重要交互式客户端工具。控制台拥有丰富的命令,包括查询区块链状态、管理区块链节点、部署并调用合约等。

## 关键特性

- 提供大量的区块链状态查询命令。
- 提供简单易用的部署和调用合约命令。
- 提供一些可以管理区块链节点的命令。
- 提供一个合约编译工具,用户可以方便快捷的将Solidity合约文件编译为Java合约文件。
- 提供一个合约转换工具,用户可将编译好的Liquid合约的物料包,例如WASM文件和ABI文件,转换成Java合约文件。

## 使用
- 可以直接下载控制台压缩包,然后解压控制台压缩包使用控制台。具体参考 [控制台手册](https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/manual/console_of_java_sdk.html)
- 可以直接下载控制台压缩包,然后解压控制台压缩包使用控制台。具体参考 [控制台手册](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/develop/console/index.html)

## 源码安装
```
$ git clone https://github.com/FISCO-BCOS/console.git
$ cd console
$ ./gradlew build
$ bash gradlew build
```
如果安装成功,将在当前目录生成一个`dist`目录。

## 配置
控制台具体配置参考[这里](https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/docs/manual/console_of_java_sdk.html#id8)
控制台具体配置参考[这里](https://fisco-bcos-doc.readthedocs.io/zh_CN/latest/docs/develop/console/console_config.html)

## 贡献代码
欢迎参与FISCO BCOS的社区建设:
Expand Down

0 comments on commit 4898dd6

Please sign in to comment.