Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 790 Bytes

README.md

File metadata and controls

26 lines (16 loc) · 790 Bytes
Raw

Doxity

Features

  • Generates contract meta data used to generate documentation

Installation

You can install @0xproject/doxity globally or locally in your project.

You'll also need solc 0.4.X until solc-js is supported (ethereum/solc-js#70 http://solidity.readthedocs.io/en/develop/installing-solidity.html - and libssl-dev installed on your machine.

# globally
npm install -g @0xproject/doxity
# or within project folder
npm install --save-dev @0xproject/doxity

Quickstart

  1. Have a project that contains natspecced* .sol contracts in a contracts directory
  2. doxity init will create a /doxity directory where contract JSON metadata will be saved
  3. doxity compile will generate contract JSON metadata to ./doxity