Skip to content

Commit

Permalink
meta RADME fix
Browse files Browse the repository at this point in the history
  • Loading branch information
andrei-marinica committed May 28, 2024
1 parent ddf4086 commit 255a39c
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 7 deletions.
11 changes: 8 additions & 3 deletions framework/meta-lib/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# Smart contract meta-programming
# Smart contract `meta` crate support

[![crates.io](https://img.shields.io/crates/v/multiversx-sc-meta.svg)](https://crates.io/crates/multiversx-sc-meta)

A meta-programming utility that works with smart contract code metadata.
The library that provides all the functionality of the individual contracts `meta` crates.

It is responsible with creating the smart contract ABIs, generating the wasm crates, and, ultimately, building the contract binaries
The purpose of the contract `meta` crates is to produce the contract ABI. Because of their access to the ABI, they have other ABI-based responsibilities, such as:
- generatinc the `wasm` crates,
- building the contracts,
- performing validations not possible otherwise,
- generating snippets,
- etc.

For more about the build process, see https://docs.multiversx.com/developers/developer-reference/sc-build-reference/
19 changes: 15 additions & 4 deletions framework/meta/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
# Smart contract meta-programming
# Smart contract meta-programming tool

[![crates.io](https://img.shields.io/crates/v/multiversx-sc-meta.svg)](https://crates.io/crates/multiversx-sc-meta)

A meta-programming utility that works with smart contract code metadata.
This is the standalone tool for creating and managing MultiversX smart contract crates.

It is responsible with creating the smart contract ABIs, generating the wasm crates, and, ultimately, building the contract binaries
## Install

All you need to do to install is:

```
cargo install multiversx-sc-meta
```

It works on both stable and nightly Rust, requires rustc 1.78 or greater.

## Documentation

Please see the explanations and CLI specifiations here: https://docs.multiversx.com/developers/meta/sc-meta

For more about the build process, see https://docs.multiversx.com/developers/developer-reference/sc-build-reference/

0 comments on commit 255a39c

Please sign in to comment.