Skip to content
Permalink
Browse files

Readme install section update

  • Loading branch information
gandreini committed Jun 8, 2015
1 parent cec0c6c commit a5a58457deb98dac9e8fa4266ef8b79fdd8b873b
Showing with 44 additions and 39 deletions.
  1. +44 −39 README.md
@@ -19,64 +19,69 @@ http://thepund.it/license/
## Install

To install the project and be ready to develop you need a few components:
* npm (nodejs >0.9)
* grunt-cli

##### On ubuntu 12.04 (and maybe others) you might need to add a repository for a recent version of nodejs
> sudo apt-get update
> sudo apt-get install -y python-software-properties python g++ make
> sudo add-apt-repository -y ppa:chris-lea/node.js
> sudo apt-get update
> sudo apt-get install nodejs
* npm (nodejs >0.9);
* grunt-cli.

#### Install npm, grunt
> sudo apt-get install npm
> sudo npm -g install grunt-cli grunt
On **Ubuntu 12.04** (and maybe others) you might need to add a repository for a recent version of nodejs:

#### Install bower
> sudo npm install -g bower
sudo apt-get update
sudo apt-get install -y python-software-properties python g++ make
sudo add-apt-repository -y ppa:chris-lea/node.js
sudo apt-get update
sudo apt-get install nodejs

#### Install pundit2
WARNING: this step must NOT be run as root, npm will just let you down.
Install **npm**, **grunt**:

> npm install
sudo apt-get install npm
sudo npm -g install grunt-cli grunt

Install bower

sudo npm install -g bower

Install **pundit2**:

**WARNING:** this step must NOT be run as root, npm will just let you down.

npm install

This will install the full toolchain to develop, build and deploy the application.

### Develop

grunt dev

## Develop
> grunt dev
Examples are built in examples/*html from examples/src/*html.
Examples are built in `examples/*html` from `examples/src/*html`.

To create a new one: add a new .html in examples/src/, include the header and footer comments
for grunt to build them correctly. Or copy one of the existing into a new one, directly.
To create a new one: add a new .html in `examples/src/`, include the header and footer comments
for grunt to build them correctly. Or copy one of the existing into a new one, directly.

The list of examples is built and included everywhere automatically.

To get a list of grunt targets:
> grunt --help
To get a list of grunt targets:

## Build
> grunt build
grunt --help

Will build a production ready pundit2 distribution in /build/:
### Build

* css/*ver*.pundit.css
* css/fonts/*
* scripts/*ver*.libs.js
* scripts/*ver*.pundit2.js
grunt build

Plus all of the examples using the production code: index.html or just *.html.
Will build a production ready pundit2 distribution in `/build/`:

Plus the documentation in /Docs.
* `css/*ver*.pundit.css`
* `css/fonts/*`
* `scripts/*ver*.libs.js`
* `scripts/*ver*.pundit2.js`

Plus all of the examples using the production code: `index.html` or just `*.html`.

Plus the documentation in `/Docs`.

# Used in this project
### Used in this project

* Js framework: Angular js https://docs.angularjs.org/api
* Css/html framework: Bootstrap http://getbootstrap.com/css/
* js+css/html: Angular strap http://mgcrea.github.io/angular-strap/
* Unit tests: http://jasmine.github.io/1.3/introduction.html
* E2E tests: https://github.com/angular/protractor/blob/master/docs/api.md
* Js framework: <a href="https://docs.angularjs.org/api" target="_blank">Angular js</a>
* Css/html framework: <a href="http://getbootstrap.com/css/" target="_blank">Bootstrap</a>
* js+css/html: <a href="http://mgcrea.github.io/angular-strap/" target="_blank">Angular strap</a>
* Unit tests: <a href="http://jasmine.github.io/1.3/introduction.html" target="_blank">Jasmine</a>
* E2E tests: <a href="https://github.com/angular/protractor/blob/master/docs/api.md" target="_blank">Protractor</a>

0 comments on commit a5a5845

Please sign in to comment.
You can’t perform that action at this time.