tracer/x-editable
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

upd readme

Browse Source
This commit is contained in:
vitalets 2013-08-31 13:35:39 +04:00
parent 0abd9831ae
commit 8be6331282
1 changed files with 37 additions and 49 deletions

86
README.md

@ -8,7 +8,7 @@ In-place editing with Twitter Bootstrap, jQuery UI or pure jQuery.
## Installation ## Installation
### Manual download ### Manual download
Use **http://vitalets.github.io/x-editable** Use **http://vitalets.github.io/x-editable** main page.
### Bower ### Bower
```` ````
@ -33,58 +33,46 @@ When creating issues please provide [jsFiddle](http://jsfiddle.net) example. You
Your feedback is very appreciated! Your feedback is very appreciated!
## Contribution ## Contribution
A few steps how to start contributing: A few steps how to start contributing.
Assuming you have [Node.js](http://nodejs.org/) already installed.
1.[Fork X-editable](https://github.com/vitalets/x-editable/fork) and pull the latest changes from <code>dev</code> branch 1.Fork *X-editable* on github and clone it to your local mashine:
2.Arrange local directory structure. It should be:
**x-editable**
| -- **lib** (repo related to <code>dev</code> and <code>master</code> branches)
| -- **gh-pages** (repo related to <code>gh-pages</code> branch for docs & demo)
| -- **playground** (simple node-server and html page for testing, [playground_1.2.zip](https://github.com/downloads/vitalets/x-editable/playground_1.2.zip), **updated in 1.2.0!**)
To make it easy follow this script ( _assuming you have [nodejs](http://nodejs.org) installed_ ).
Please replace <code>&lt;your-github-name&gt;</code> with your name:
```` ````
mkdir x-editable git clone https://github.com/<your-github-name>/x-editable.git -b dev
cd x-editable ````
2.Install *grunt-cli* globally (if not yet):
#lib ````
git clone https://github.com/<your-github-name>/x-editable.git -b dev lib npm i -d grunt-cli
cd lib ````
#install gruntjs globally - building tool 3.Install dependencies:
npm install -g grunt ````
#install other dependencies - grunt-contrib npm i
npm install ````
cd .. 4.Make your awesome changes.
````
#gh-pages vim editable-form.js
git clone https://github.com/<your-github-name>/x-editable.git -b gh-pages gh-pages ````
cd gh-pages 5.Run tests:
npm install ````
cd .. grunt test
````
#playground 6.Commit and push back on github:
#download playground.zip from https://github.com/downloads/vitalets/x-editable/playground_1.2.zip ````
unzip playground.zip git add .
cd playground git commit -m'refactor editable form, fix #123'
npm install git push origin
```` ````
3.That's it! You can start editing files in **lib/src** directory or create new editable input/container/whatever. 7.Make pull request on github.
To test the result go to **playground**, start server <code>node server.js</code> and open in your browser [http://localhost:3000/playground](http://localhost:3000/playground).
4.To run unit tests you can open it directly in browser **lib/test/index.html**.
Or use grunt's _qunit_ task <code>grunt test</code>. For that you also need to [install PhantomJS](https://github.com/gruntjs/grunt/blob/master/docs/faq.md#why-does-grunt-complain-that-phantomjs-isnt-installed)
5.To build distributive run <code>grunt build</code> in **lib** directory. Result will appear in **lib/dist**.
6.To build docs run <code>build data-docs-dist</code> in **gh-pages** directory. Result will appear in **gh-pages/*.html**.
Do not edit **index.html** and **docs.html** directly! Instead look at [Handlebars](https://github.com/wycats/handlebars.js) templates in **generator/templates**.
7.Commit changes on <code>dev</code> / <code>gh-pages-dev</code> branch and make pull request as usual.
Thanks for your support! Thanks for your support!
### Local build
To build x-editable locally please run:
````
grunt build
````
Result will appear in `dist` directory.
## License ## License
Copyright (c) 2012 Vitaliy Potapov Copyright (c) 2012 Vitaliy Potapov
Licensed under the MIT license. Licensed under the MIT license.