Skip to content

Commit

Permalink
docs: improve README emojis and quality section
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremylgn committed Oct 2, 2023
1 parent a33fd65 commit 276cf9a
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
This repository hosts Smart Contracts that are deployed on the [OKP4 network](http://okp4.network). But they are compatible with any
[Cosmos blockchains](https://cosmos.network/) that uses the [CosmWasm](https://cosmwasm.com/) framework.

### 🗄️ Storage oriented Smart Contracts
## 🗄️ Storage oriented Smart Contracts

<table>
<tr>
Expand Down Expand Up @@ -50,7 +50,7 @@ This repository hosts Smart Contracts that are deployed on the [OKP4 network](ht
</tr>
</table>

### ⚖️ Sovereignty oriented Smart Contracts
## ⚖️ Sovereignty oriented Smart Contracts

<table>
<tr>
Expand Down Expand Up @@ -113,7 +113,7 @@ The project is structured around a set of Rust workspaces, each defining a smart

## 🏗 Build

### Pre-requisites
### 🔨 Pre-requisites

Be sure you have the following tools installed:

Expand All @@ -128,7 +128,7 @@ And the following common [GNU Core utilities](https://en.wikipedia.org/wiki/List
- [shasum](https://linuxhint.com/shasum-linux/) v6.02 or higher
- [sed](https://www.gnu.org/software/sed/) v4.8 or higher

### Compiling Smart Contracts to Wasm
### 🔧 Compiling Smart Contracts to Wasm

To compile the Smart Contracts to Wasm, just invoke the `wasm` goal of the makefile:

Expand All @@ -139,7 +139,7 @@ cargo make wasm
This will install the rust Wasm toolchain, if not already done, and start the process for compiling the Smart Contracts
to Wasm.

### Test Smart Contracts
## Test Smart Contracts

The Smart Contracts are under unit testing. The tests can be launched with the following invocation:

Expand Down Expand Up @@ -174,7 +174,7 @@ The list of available tasks for managing the chain is as follows:
- `chain-start` - Run the full node okp4d application using the chain's home directory under a Docker container.
- `chain-stop` - Stop the chain's container.

### Initialize the chain
## 🚀 Initialize the chain

To initialize the chain, just run:

Expand All @@ -185,7 +185,7 @@ cargo make chain-initialize
This will initialize the chain's home directory and create a validator's key and a set of predefined keys
(recovered from the seed phrases).

### Start the chain
### 🟢 Start the chain

To start the chain, just run:

Expand All @@ -201,7 +201,7 @@ You can check the chain's logs with:
cargo make chain-logs
```

### Deploy the Smart Contracts
### 🛳 Deploy the Smart Contracts

To deploy the Smart Contracts, just run:

Expand All @@ -214,7 +214,7 @@ must be present in the artifacts directory. See the [Build](#-build) section for

Now, you can interact with the deployed smart contracts and test them out.

### Free execution of the CLI command
### 🎮 Free execution of the CLI command

You can freely interact with the local chain by executing the following CLI command. This will execute the `okp4d`
binary
Expand All @@ -232,15 +232,15 @@ For example, to check the status of the chain, just run:
cargo make chain status
```

### Stop the chain
### 🔴 Stop the chain

To stop the chain, just run:

```sh
cargo make chain-stop
```

### Clean the chain
### 🧼 Clean the chain

To clean the chain, just run:

Expand All @@ -251,19 +251,19 @@ cargo make chain-clean
⚠️ Please be cautious when running this command as it will completely clean the chain's home directory and the action is
irreversible.

## Develop
## 💻 Develop

### Smart Contracts scaffolding
### 🏗 Smart Contracts scaffolding

When developing a new Smart Contract, you can use the scaffolding to generate the Smart Contract's code.

#### Pre-requisites
#### 🔨 Pre-requisites

Be sure you have the following tools installed:

- [ffizer](https://ffizer.github.io/ffizer/book/#install) v2.10.3 or higher

#### Generate the scaffolding
#### 🚧 Generate the scaffolding

To generate the scaffolding, just run:

Expand All @@ -273,14 +273,14 @@ cargo make scaffold-smart-contract

Then, follow the instructions.

### Documentation
## 📚 Documentation

The documentation of the smart contracts must be committed to the repository. The documentation is generated from the
smart contracts' schema.

To generate the documentation follow the steps below.

#### Pre-requisites
### 🔨 Pre-requisites

Be sure you have the following tools installed:

Expand All @@ -292,7 +292,7 @@ Then, install the dependencies:
yarn global add @adobe/[email protected]
```

#### Generate the documentation
### 🖨 Generate the documentation

To generate the documentation, just run:

Expand All @@ -303,7 +303,7 @@ cargo make docs-generate

You'll find the generated documentation under the `docs` folder.

#### Commit the documentation
### 🗒 Commit the documentation

When developing a new contract, you should commit the generated documentation to the repository. For this, generate the
documentation and commit the changes:
Expand All @@ -312,7 +312,7 @@ documentation and commit the changes:
git commit -am "docs: update generated documentation"
```

## Resources
## 📘 Resources

- [CosmWasm Docs](https://docs.cosmwasm.com/)
- [OKP4 Whitepaper](https://docs.okp4.network/whitepaper/abstract)
Expand Down

0 comments on commit 276cf9a

Please sign in to comment.