Skip to content

Commit

Permalink
Update readme (#232)
Browse files Browse the repository at this point in the history
Fix #231
  • Loading branch information
0xAWM authored Oct 6, 2023
1 parent 68260e9 commit 719e838
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 14 deletions.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,24 +33,21 @@ Test Coverage:

<sub>\* B1 and B2 contain 72 single-contract projects from SMARTIAN artifacts. Tests are the projects in `tests` directory. The coverage is calculated as `(instruction covered) / (total instruction - dead code)`. </sub>

<br/>
<br/>

---

# Installation
## ityfuzzup **(Recommended)**
## 1. ityfuzzup **(Recommended)**

ityfuzzup is a script that automatically installs all dependencies and builds ItyFuzz.
```bash
curl -L https://raw.githubusercontent.com/fuzzland/ityfuzz/master/ityfuzzup/ityfuzzup | bash
curl -L https://raw.githubusercontent.com/fuzzland/ityfuzz/master/ityfuzzup/install | bash
```

## Release
## 2. Release

Download the latest release from [here](https://github.com/fuzzland/ityfuzz/releases/latest).

## Docker
## 3. Docker

Install [Docker](https://www.docker.com/) and run docker image suitable for your system architecture:

Expand All @@ -63,8 +60,7 @@ Then, you can visit the interface at http://localhost:8000

<sub>Note: The container uses public ETH RPC, may time out / be slow</sub>


## Build from Source
## 4. Build from Source

You first need to install Rust through https://rustup.rs/

Expand Down
10 changes: 5 additions & 5 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,17 @@ ItyFuzz 是一款快速的混合模糊测试工具,用于 EVM、MoveVM(WIP

# 安装

## ityfuzzup (推荐)
## 1. ityfuzzup (推荐)

```bash
curl -L https://raw.githubusercontent.com/fuzzland/ityfuzz/master/ityfuzzup/ityfuzzup | bash
curl -L https://raw.githubusercontent.com/fuzzland/ityfuzz/master/ityfuzzup/install | bash
```

## Release
## 2. Release

下载最新的 [release](https://github.com/fuzzland/ityfuzz/releases/latest)

## Docker
## 3. Docker

安装 [Docker](https://www.docker.com/) 并运行适用于你的系统架构的 docker 镜像:

Expand All @@ -58,7 +58,7 @@ docker run -p 8000:8000 fuzzland/ityfuzz:stable

<sub>注意:容器使用公共 ETH RPC,可能超时或运行缓慢</sub>

## 从源码构建
## 4. 从源码构建

您需要安装 `libssl-dev`(OpenSSL)和 `libz3-dev`(参见[Z3 安装](#z3-installation)章节中的说明)。

Expand Down

0 comments on commit 719e838

Please sign in to comment.