#move #diem #readme

bin+lib move-readme

Generates a readme from a Move package

1 unstable release

0.1.0 Jul 9, 2022

#4 in #diem

21 downloads per month

Apache-2.0

19KB
109 lines

move-readme

Generates a readme from a Move package.

Setup

Install the CLI using Cargo:

cargo install move-readme

# On Sui
cargo install move-readme --features address20

# On Aptos
cargo install move-readme --features address32

Usage

In a directory containing a Move.toml, run:

move-readme

This will write a README.md file to the current directory.

License: Apache-2.0


lib.rs:

Generates a readme from a Move package.

Setup

Install the CLI using Cargo:

cargo install move-readme

# On Sui
cargo install move-readme --features address20

# On Aptos
cargo install move-readme --features address32

Usage

In a directory containing a Move.toml, run:

move-readme

This will write a README.md file to the current directory.

Dependencies

~24–41MB
~694K SLoC