Skip to content

Commit

Permalink
Updated readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ankerbachryhl authored Nov 28, 2016
1 parent 91dfed3 commit 55825c2
Showing 1 changed file with 4 additions and 50 deletions.
54 changes: 4 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,9 @@
# A template for the Coding Pirates gamejam 2016!
# Ninja Cat Adventure

Template by:
[ankerbachryhl](https://github.com/ankerbachryhl).
A game made to the Coding Pirates gamejam 2016!

## Installation
It was made by:

### Requirements
Anker, Felix, Tobias, Christian og Benjamin!

This games uses [gulp](http://gulpjs.com/) for building and tasks automation.

You can install gulp with npm:

```
npm install -g gulp
```

### Build

Clone this repository and install dependencies:

```
git clone https://github.com/ankerbachryhl/phaserjam.git
cd phaserjam
npm install
```

To **build** the game, run the `dist` task from the project root:

```
gulp dist
```

The `dist` folder will contain a build of the game. You can then start a local server that serves this directory statically to play the game in local:

```
npm install -g http-server
http-server dist
```

You can **clean up** the temporary files and the `dist` folder by running:

```
gulp clean
```

## Development

This project uses [Browserify](http://browserify.org) to handle JavaScript modules.

There is a task that will automatically run Browserify when a JavaScript file changes, and it will also reload the browser.

```
gulp run
```

0 comments on commit 55825c2

Please sign in to comment.