Skip to content

Commit

Permalink
edit man page and actually test it this time
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeff Escalante committed Jan 18, 2013
1 parent 189316b commit 2bd6788
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 26 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "roots",
"version": "1.0.1-2",
"version": "1.0.1-3",
"description": "roots is a toolbox for building simple, beautiful, and efficient products for the web",
"keywords": [
"front-end",
Expand Down
37 changes: 25 additions & 12 deletions setup/man/roots.1
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,8 @@
.SH "NAME"
\fBroots\fR \-\- a toolkit for quickly building beautiful websites
.
.SH "NAME"
roots \-\- refer to http://roots\.cx for details
.
.SH "SYNOPSIS"
\fBroots\fR <option>
\fBroots\fR <options>
.
.SH "DESCRIPTION"
Roots exposes a variety of commands for creating, managing, compiling, and deploying websites\.
Expand All @@ -19,35 +16,51 @@ Roots exposes a variety of commands for creating, managing, compiling, and deplo
The following commands are available:
.
.IP "\(bu" 4
\fBnew\fR, \fB<name>\fR, \-\-<type>
\fBnew\fR, \fB<name>\fR, \-\-<type>
.
.br
create a new roots project called <name>\. <type> can be <express> or <basic>\.
.
.IP "\(bu" 4
\fBcompile\fR, \-\-<no\-compress>
\fBcompile\fR, \-\-<no\-compress>
.
.br
compile, compress, and minify the project to \fBpublic\fR, adding the option <no\-compress> will bypass the compression
.
.IP "\(bu" 4
\fBwatch\fR
\fBwatch\fR
.
.br
watch your project and compile/reload whenever a file is saved\. does not work for roots\-express or roots\-rails
.
.IP "\(bu" 4
\fBdeploy\fR, \fB<name>\fR
\fBdeploy\fR, \fB<name>\fR
.
.br
configure, compile, commit, and deploy your project to heroku
.
.IP "\(bu" 4
\fBupdate\fR
\fBupdate\fR
.
.br
upgrade to the latest version of roots
.
.IP "\(bu" 4
\fBversion\fR
\fBversion\fR
.
.br
print the version of the current roots install
.
.IP "\(bu" 4
\fBjs\fR, \fB<command>\fR, \fB<option>\fR
\fBjs\fR, \fB<command>\fR, \fB<option>\fR
.
.br
exposes bower\'s interface\. type \fBroots js\fR for help with bower
.
.IP "\(bu" 4
\fBplugin\fR, \fB<command>\fR, \fB<option>\fR
\fBplugin\fR, \fB<command>\fR, \fB<option>\fR
.
.br
manages plugins\. command can be \fBgenerate\fR with an optional flag of \fB\-\-js\fR for generate a coffeescript or javascript plugin template\. command can be \fBinstall\fR with the option being \fBusername/repo\fR on github to install a plugin into the /plugins folder
.
.IP "" 0
Expand Down
22 changes: 9 additions & 13 deletions setup/roots.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,38 @@
roots(1) -- a toolkit for quickly building beautiful websites
=============================================================

## NAME

roots -- refer to http://roots.cx for details

## SYNOPSIS

`roots` <option>
`roots` <options>

## DESCRIPTION

Roots exposes a variety of commands for creating, managing, compiling, and deploying websites.

The following commands are available:

* `new`, `<name>`, --<type>
* `new`, `<name>`, --<type>
create a new roots project called <name>. <type> can be <express> or <basic>.

* `compile`, --<no-compress>
* `compile`, --<no-compress>
compile, compress, and minify the project to `public`, adding the option <no-compress> will bypass the compression

* `watch`
* `watch`
watch your project and compile/reload whenever a file is saved. does not work for roots-express or roots-rails

* `deploy`, `<name>`
* `deploy`, `<name>`
configure, compile, commit, and deploy your project to heroku

* `update`
* `update`
upgrade to the latest version of roots

* `version`
* `version`
print the version of the current roots install

* `js`, `<command>`, `<option>`
* `js`, `<command>`, `<option>`
exposes bower's interface. type `roots js` for help with bower

* `plugin`, `<command>`, `<option>`
* `plugin`, `<command>`, `<option>`
manages plugins. command can be `generate` with an optional flag of `--js` for generate a coffeescript or javascript plugin template. command can be `install` with the option being `username/repo` on github to install a plugin into the /plugins folder

## DOCUMENTATION
Expand Down

0 comments on commit 2bd6788

Please sign in to comment.