Skip to content

Commit

Permalink
Added ZIP file
Browse files Browse the repository at this point in the history
  • Loading branch information
kittykatattack committed Nov 3, 2015
1 parent 1fa61a3 commit 316aacc
Show file tree
Hide file tree
Showing 7 changed files with 66 additions and 7 deletions.
63 changes: 61 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,65 @@
After cloning this repository, `cd` into the root directory and run
the following two commands:
Learn PixiJS
============

This is the code repository for the book [Learn
PixiJS](http://www.springer.com/us/book/9781484210956).

There are two ways to access the source code: by downloading the ZIP file or by
cloning this repository.

The ZIP file
-----------

The easiest way is just to download the ZIP file. It contains a
frozen snapshot of all the source code for *Learn PixiJS* as it was on the
day the book was published. That means it's guaranteed to work with code in the book.

Clone this repository
---------------------

Alternatively, you can use git to clone this repository. (If you don't
know how to use git (you can find out
here)[https://github.com/kittykatattack/learningGit].) Cloning the
repository will
give you the latest version of the submodules, including the latest
version of Pixi. (Be aware that the source code in the book was tested
with Pixi 3.0.7. If you are using a later version of
Pixi you may encounter incompatibilities.)

To clone this repository, run the following in the command line:
```
git clone [email protected]:kittykatattack/learningGit.git
```
When it's finished run the following two commands:
```
git submodule init
git submodule update
```
To optionally update the submodules to the very latest versions, run this
command:
```
git submodule foreach git pull origin master
```
This will pull the latest versions of the submodules from their
repositories.

Launching a web server
------------------

You'll need to launch a web server in the root repository directory. A
modern text editor like (Light Table)[http://lighttable.com],
(Brackets)[http://brackets.io] or (Atom)[https://atom.io] will
launch one for you automatically, directly from the editor, when you
open and view an HTML file in the browser.

Or you could launch a web server directly from the command line using
(http-server)[https://github.com/indexzero/http-server]. After the server starts, navigate to
`http://localhost:8080/` in your browser and you'll be able to
interact with working
versions of all the example files in the book.

Keeping up with Pixi
--------------------

Pixi is an actively developed library, so make sure you (keep an eye on
Pixi's code repository)[https://github.com/pixijs/pixi.js] for any changes to the API.
Binary file added learnPixiJS.zip
Binary file not shown.
2 changes: 1 addition & 1 deletion library/bump
Submodule bump updated 1 files
+1 −1 src/bump.js
2 changes: 1 addition & 1 deletion library/charm
Submodule charm updated 1 files
+1 −1 src/charm.js
2 changes: 1 addition & 1 deletion library/dust
Submodule dust updated 2 files
+28 −20 README.md
+1 −1 src/dust.js
2 changes: 1 addition & 1 deletion library/spriteUtilities
2 changes: 1 addition & 1 deletion library/tink

0 comments on commit 316aacc

Please sign in to comment.