Skip to content

Commit

Permalink
Updating readme for NPM
Browse files Browse the repository at this point in the history
  • Loading branch information
sgmeyer committed Oct 17, 2013
1 parent abf93a5 commit 02404ff
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
generator-crafty
================



## Features

* CSS minification
Expand All @@ -11,25 +13,25 @@ generator-crafty

Yeoman.io generator for Crafty.js game engine.

This is currently not deployed to the Node Package Manager (NPM). Until this is ready for primetime feel free to link this locally. The following steps will setup your Craft.js scaffolding. The scaffolding is based on the CraftyBoilerplate (https://github.com/ahilles107/CraftyBoilerplate).
You can install this generator using the Node Package Manager (npm). The following steps will setup your Craft.js scaffolding. The scaffolding is based on the CraftyBoilerplate (https://github.com/ahilles107/CraftyBoilerplate).

## Installation (Currently not deployed to Node Package Manager)
## Installation (Node, NPM, and Yeoman)

- Make sure you have yo, grunt, node and NPM installed.
- Open the root directory of `generator-crafty`
- Install the generators dependencies by typing the command `npm install`.
- Type the command `npm link`. This will link the Yeoman generator to your local NPM.

## Usage - Setup Game Scaffolding
- Create a new game directory anywhere you'd like. By default the game name will be the name of the directory.
- With your terminal go to the game directory.
- Type the command `yo crafty`
- If you want to override your game name Yeoman will ask you otherwise it defaults to the root directoy name.
## Usage

## Usage - Preview Server and LiveReload
Install `generator-crafty`:
```
npm install -g generator-crafty
```

To build and run your application locally you can use the included Grunt setup. Here's how to be a terminal ninja.
Make a new directory, and `cd` into it:
```
mkdir my-new-project && cd $_
```

- open up the terminal.
- Navigate to your games root directory. This directory will contain the Gruntfile.js file.
- You can use the `grunt server` command to clean, minify/copy/build, run node server, open default browser.
Run `yo crafty`
```

0 comments on commit 02404ff

Please sign in to comment.