-
Notifications
You must be signed in to change notification settings - Fork 85
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Minor fixes to documentation and website
- Loading branch information
Showing
8 changed files
with
153 additions
and
156 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,32 @@ | ||
### Issues | ||
|
||
Please provide jsFiddle examples as well when reporting bugs. | ||
Please provide code examples as well when reporting bugs. | ||
|
||
### Pull requests | ||
|
||
1. Please make your changes to the plugin code in the `/src` files, and not in the `/dist` files. | ||
2. To test your code use `/testing/index.html`. | ||
3. Keep your pull request simple and avoid doing any unintended changes. | ||
4. Don't commit any changes to `/dist/itemslide.min.js` | ||
1. Keep your pull request simple and avoid doing any unintended changes. | ||
1. Don't commit any changes to `/dist/itemslide.min.js` | ||
|
||
This project is built using Browserify so if you want to contribute make sure you have a basic understanding of it. | ||
This project is built using webpack so if you want to contribute make sure you have a basic understanding of it. | ||
|
||
#### Building | ||
|
||
Before starting make sure you have Node.js installed on your system. | ||
|
||
First install the devDependencies by typing- | ||
First install the dependencies by typing: | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
You can use watch so that itemslide will be built as you make changes to the `/src` files: | ||
You can use watch so that ItemSlide will be built as you make changes to the `/src` files: | ||
|
||
```bash | ||
npm run-script watch | ||
npm run watch | ||
``` | ||
|
||
Or manually build the project using: | ||
Or build the project using: | ||
|
||
```bash | ||
npm run-script testing-build | ||
npm run build | ||
``` |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
/*! /* ItemSlide.js - Licensed under the MIT license - itemslide.org/license.html * / */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.