Installation

Sections

• Download
  • GitHub Releases
  • Dependency Management
• Build

Download

GitHub Releases

You can download official releases here.

Dependency Management

Just run the following on the CLI (provided your CLI is directed to your work directory)

Node Package Manager (NPM)

npm install famfamfam-flags

Bower

bower install famfamfam-flags

Composer

composer require t1st3/famfamfam-flags

Nuget

Install-Package famfamfam-flags

Build

We use Gulp to build the project, so if you want to re-build or customize this project, you'll need Gulp.

After gulp is installed, and your CLI is pointed to your work directory, first install the dependencies:

 npm install

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

 gulp build

What the build task does?

First, it takes PNG and GIF files from the src/ directory, and tidies them to the dist/ directory.

Then it creates a spritesheet from the PNG images located in the src/ directory, and thus creates the sprite/ directory in dist/.

If, for example you just want fr and gg icons in a spritesheet, you just have to fork this project, point your CLI to the working directory, empty the src/ directory, except fr and gg icons in PNG format, and then run the gulp build task.

You'll get the proper spritesheet and copies of the icons directly in the dist/ directory.