- This project is a fork of
- Generates contract meta data used to generate documentation
You can install
@joincivil/doxity globally or locally in your project.
You'll also need
solc 0.4.X until solc-js is supported (https://github.com/ethereum/solc-js/issues/70)- http://solidity.readthedocs.io/en/develop/installing-solidity.html - and libssl-dev installed on your machine.
# globally npm install -g @joincivil/doxity # or within project folder npm install --save-dev @joincivil/doxity
- Have a project that contains natspecced*
.solcontracts in a
doxity initwill create a
/doxitydirectory where contract JSON metadata will be saved
doxity compilewill generate contract JSON metadata to