日本語 / English

npm version CircleCI

I read you (ireadu)

README等のマークダウンファイルから、コマンドを抽出します。

I read you (ireadu) demo movie

Linux、Windows Subsystems for Linux、macOSで動作します。

インストール

$ npm install --global i-read-u

要求環境

Node.js v6.0+

使い方

$ ireadu
$ ireadu --file ./CONTRIBUTING.md

その他の情報は$ ireadu --helpを参照ください。

試してみる(ireaduコマンドを実行してみてください)

$ ls
>w

…and ` # pwd, id`.

開発者用

git cloneして下記を実行してください。

$ npm install --save-dev
$ npm run webpack-watch
$ bin/ireadu.js

Linting

$ npm run lint
$ npm run lint:fix

Testing

$ npm test
$ explorer.exe `wslpath -w coverage/lcov-report/index.html`

ライセンス

MIT.