Skip to content

Commit

Permalink
Update README.md (#79)
Browse files Browse the repository at this point in the history
  • Loading branch information
AstaFrode authored Jul 8, 2023
1 parent 6ca02c8 commit c3c664d
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ https://testnet-faucet.cess.cloud/
## :warning: Attention
The following commands are executed with root privileges, if the prompt `Permission denied` appears, you need to switch to root privileges, or add `sudo` at the top of these commands.

## System Requirements
## ⚙ System configuration
### System requirements
- Linux 64-bit Intel/AMD

## System configuration
### Install application tools

For the Debian and ubuntu families of linux systems:
Expand Down Expand Up @@ -77,9 +77,17 @@ iptables -A INPUT -p tcp --dport 8080 -j ACCEPT
service iptables restart
```

## Build from source
## 🏗 Get the binary program
### Method one
Download the latest release of the binary application directly at:
```
wget https://github.com/CESSProject/DeOSS/releases/download/v0.2.2/deoss
```

### Method two
Compile the binary program from the DeOSS source code and follow the process as follows:

### Step 1: Install go
**1) install go**

DeOSS requires [Go 1.19](https://golang.org/dl/) or higher, See the [official Golang installation instructions](https://golang.org/doc/install).

Expand All @@ -93,29 +101,24 @@ Users in China can add go proxy to speed up the download:
go env -w GOPROXY="https://goproxy.cn,direct"
```

### Step 2: Clone code
**2) clone code**
```
git clone https://github.com/CESSProject/DeOSS.git
```

Run unit test:
**3) compile code**
```
cd DeOSS/
go test -v ./...
```

### Step 3: Build a deoss
```
go build -o deoss cmd/main.go
```

### Step 4: Grant execute permission
**4) Grant execute permission**

```shell
chmod +x deoss
```

## Configure Wallet
## 💰 Configure Wallet

### Step 1: create a wallet account
The wallet is your unique identity in the cess network, it allows you to do transactions with the cess chain, provided that you have some balance in your wallet.
Expand Down Expand Up @@ -152,7 +155,7 @@ P2P_Port: 4001
HTTP_Port: 8080
```
## Start deoss service
## 🟢 Start deoss service
Backend operation mode:
```shell
nohup ./deoss run 2>&1 &
Expand All @@ -168,7 +171,7 @@ nohup ./deoss run 2>&1 &
./deoss exit
```

# Usage for DeOSS API
# 📖 Usage for DeOSS API

The public API endpoint URL of DeOSS is the server you deploy, All endpoints described in this document should be made relative to this root URL,The following example uses URL instead.

Expand Down

0 comments on commit c3c664d

Please sign in to comment.