Implement basic man page

This commit is contained in:
Juan Cruz Viotti 2014-12-10 15:18:39 -04:00
parent b24b13f549
commit e4780b12f6
4 changed files with 47 additions and 2 deletions

View File

@ -58,7 +58,17 @@ You can renegerate the documentation with:
$ npm run-script doc
```
This should ideally be part of `gulp`, however there doesn't seems to be any plugin for the documentation generation tool that we're using at the moment ([codo](https://github.com/coffeedoc/codo)).
## Manual pages
UNIX manual pages reside in `doc/`
You can regenerate UNIX `roff` manual pages from markdown with:
```sh
$ npm run-script man
```
If you add a new `man` page, remember to add the `roff` filename to the `man` array in `package.json`.
## Caveats

14
doc/resin.1.md Normal file
View File

@ -0,0 +1,14 @@
resin(1) - command line tool to interact with resin.io
======================================================
## SYNOPSIS
`resin` [options] <command>
## DESCRIPTION
**resin** is a powerful command line application to interact, develop and deploy resin.io applications and devices.
## COPYRIGHT
resin is Copyright (C) 2014 Resin.io <https://resin.io>

16
doc/resin.1.roff Normal file
View File

@ -0,0 +1,16 @@
.\" Generated with Ronnjs 0.4.0
.\" http://github.com/kapouer/ronnjs
.
.TH "RESIN" "1" "December 2014" "" ""
.
.SH "NAME"
\fBresin\fR \-\- command line tool to interact with resin\.io
.
.SH "SYNOPSIS"
\fBresin\fR [options] <command>
.
.SH "DESCRIPTION"
\fBresin\fR is a powerful command line application to interact, develop and deploy resin\.io applications and devices\.
.
.SH "COPYRIGHT"
resin is Copyright (C) 2014 Resin\.io \fIhttps://resin\.io\fR

View File

@ -8,11 +8,15 @@
"url": "git@bitbucket.org:rulemotion/resin-cli.git"
},
"preferGlobal": true,
"man": [
"./doc/resin.1.roff"
],
"bin": {
"resin": "./bin/resin"
},
"scripts": {
"test": "cult test",
"man": "ronn --build --roff doc/*.md",
"doc": "codo -o ./doc/codo `find lib/resin -name \"*.coffee\" | grep -v \"spec.coffee$\"`"
},
"keywords": [
@ -40,7 +44,8 @@
"gulp-util": "~3.0.1",
"run-sequence": "~1.0.2",
"chai-string": "~1.1.0",
"codo": "~2.0.9"
"codo": "~2.0.9",
"ronn": "~0.4.0"
},
"dependencies": {
"request": "~2.47.0",