Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Improve CLI readme

  • Loading branch information...
commit 112eeaa84e1be969063300382f87bc293b609a61 1 parent 3856798
@sindresorhus sindresorhus authored
Showing with 18 additions and 27 deletions.
  1. +17 −26 cli/readme.md
  2. +1 −1  readme.md
View
43 cli/readme.md
@@ -1,22 +1,20 @@
+# Yeoman CLI
-
-## Yeoman CLI
-
-The Yeoman CLI presents a command line interface for creating, building, maintaining, and shipping a project. For more information on the CLI, please see the projects docs.
+The Yeoman CLI presents a command-line interface for creating, building, maintaining, and shipping a project. For more information on the CLI, please see the projects docs.
## Quick start
-```
-# sudo npm install -g
-# sudo npm link (otherwise you'll get exceptions at the moment during scaffolding setup)
+```sh
+$ sudo -s 'npm install -g && npm link'
```
Next, navigate to where you would like to create a new project and then run:
```yeoman init```
-**run the tests**
+
+## Run tests
You can run the tests via `npm test` if you like. It will:
@@ -27,26 +25,19 @@ You can run the tests via `npm test` if you like. It will:
* and perfom few basic assertions, comparing *.html files in
`.test/publish` with the expected ones in `test/fixtures`
-# Current components
-* Compass
-* Grunt
+## Current components
+
* Twitter Bootstrap
-* Html5 Boilerplate
+* HTML5 Boilerplate
* Modernizr
-* Node
+* Twitter Bower
+* Node.js
* NPM
-* Twitter Nest
-* socket.io
-* coffeescript
-* mocha
-* jasmine
+* Compass
+* Socket.IO
+* CoffeeScript
+* Mocha
+* Jasmine
* PhantomJS
-* optipng, jpegtran
-* connect
-* html-minifier
-* clean-css
-* node-build-script
-* compass_bootstrap
-
-
+* And [more...](https://github.com/yeoman/yeoman/wiki/Dependencies)
View
2  readme.md
@@ -23,7 +23,7 @@ following steps resolve these issues:
```
$ cd yeoman/cli
-$ sudo npm install -g && npm link
+$ sudo -s 'npm install -g && npm link'
```
## Running
Please sign in to comment.
Something went wrong with that request. Please try again.