Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added markdown code blocks to Readme.md #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added markdown code blocks to Readme.md #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The aim of this project is to make this icon pack available through various pack
- [NuGet](https://www.nuget.org)


All icons are supplied in GIF format.
All icons are supplied in `GIF` format.


## CSS spritesheets
Expand Down Expand Up @@ -57,22 +57,22 @@ Just remember to add the CSS stylesheet to the HEAD of your HTML page!

Get the package with NPM

> npm install famfamfam-mini
> `npm install famfamfam-mini`


Get the package with Bower

> bower install famfamfam-mini
> `bower install famfamfam-mini`


Get the package with Composer / Packagist

> composer require legacy-icons/famfamfam-mini
> `composer require legacy-icons/famfamfam-mini`


Get the package with NuGet

> Install-Package famfamfam-mini
> `Install-Package famfamfam-mini`


## Build the whole project or your custom project
Expand All @@ -83,26 +83,26 @@ After gulp is installed, and your CLI is pointed to your work directory, first i

**with NPM 2.x.x**

> npm install
> `npm install`

**with NPM 3.x.x** (resolve dependencies for `node-spritesheet` before this module's ones)

> npm install grunt grunt-contrib-coffee grunt-contrib-clean
> `npm install grunt grunt-contrib-coffee grunt-contrib-clean`

> npm install
> `npm install`

then be sure that you have *[ImageMagick](http://www.imagemagick.org/script/binary-releases.php)* installed for building spritesheet.

then, you can run the `gulp build` task to build the project:

> gulp build
> `gulp build`


### What the build task does?

First, it copies GIF files from the `src` folder, and pastes them to the `dist` folder.
First, it copies `GIF` files from the `src` folder, and pastes them to the `dist` folder.

Then it creates a spritesheet from the GIF images located in the `src` folder, and thus creates the `sprite` folder in `dist`.
Then it creates a spritesheet from the `GIF` images located in the `src` folder, and thus creates the `sprite` folder in `dist`.

If, for example you just want `action_stop` and `page_right` icons in a spritesheet, you just have to fork this project, point your CLI to the working directory,
empty the `src` directory, except `action_stop` and `page_right` icons in GIF format, and then run the `gulp build` task.
Expand Down