forked from yeoman/yeoman
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request yeoman#316 from sindresorhus/improve-readme
Improve the readme and remove outdated info
- Loading branch information
Showing
1 changed file
with
2 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,5 @@ | ||
# 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. | ||
|
||
|
||
## Quick start | ||
|
||
```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 tests | ||
|
||
You can run the tests via `npm test` if you like. It will: | ||
|
||
* create the `.test/` directory | ||
* run `yeoman init --noprompt` | ||
* copy in `.test/img` a few png files | ||
* run `yeoman build:minify` | ||
* and perfom few basic assertions, comparing *.html files in | ||
`.test/publish` with the expected ones in `test/fixtures` | ||
|
||
|
||
## Current components | ||
|
||
* Twitter Bootstrap | ||
* HTML5 Boilerplate | ||
* Modernizr | ||
* Twitter Bower | ||
* Node.js | ||
* NPM | ||
* Compass | ||
* Socket.IO | ||
* CoffeeScript | ||
* Mocha | ||
* Jasmine | ||
* PhantomJS | ||
* And [more...](https://github.com/yeoman/yeoman/wiki/Dependencies) | ||
For more information, see the project [readme](https://github.com/yeoman/yeoman#welcome-friend). |