Skip to content

Commit 699ad7b

Browse files
committed
added readme
1 parent 8b95ea7 commit 699ad7b

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
Gamz project
2+
============
3+
4+
Quality games on the web, without Flash.
5+
6+
License is not yet determined, you can fork, make pull request and use at home, but not build business on top of it.
7+
More informations to come later.
8+
9+
10+
Installation
11+
------------
12+
13+
1. As Gamz is a [Symfony2](http://symfony.com/) project, you first need PHP 5.3 and the webserver of your choice.
14+
15+
2. Javascripts are written in [CoffeeScript](http://jashkenas.github.com/coffee-script)
16+
so you'll need [Node.js](http://nodejs.org) and [npm](http://npmjs.org/):
17+
18+
- [Install Node.js](https://github.com/joyent/node/wiki/Installation)
19+
- [Install npm](https://github.com/isaacs/npm)
20+
- Install CoffeeScript compiler: `npm install -g coffee-script`
21+
22+
3. CSS are written with [Sass](http://sass-lang.com/) and [Compass](http://compass-style.org/)
23+
wich need [Ruby](http://www.ruby-lang.org/):
24+
25+
- [Install Ruby](http://www.ruby-lang.org/en/downloads/)
26+
- [Install Sass](http://sass-lang.com/download.html)
27+
- [Install Compass](http://compass-style.org/install)
28+
29+
3. Get the sources via git with submodules
30+
31+
git clone [email protected]:gamz/GamzProject.git
32+
git submodule update --init
33+
34+
4. Install vendors:
35+
36+
./bin/vendor install
37+
38+
5. Configure parameters:
39+
40+
cp app/config/parameters.yml.dist app/config/parameters.yml
41+
vim app/config/parameters.yml

0 commit comments

Comments
 (0)