# vscode-icons

[![Version](https://vsmarketplacebadge.apphb.com/version/vscode-icons-team.vscode-icons.svg)](https://marketplace.visualstudio.com/items?itemName=vscode-icons-team.vscode-icons)
[![Installs](https://vsmarketplacebadge.apphb.com/installs-short/vscode-icons-team.vscode-icons.svg)](https://marketplace.visualstudio.com/items?itemName=vscode-icons-team.vscode-icons)
[![Ratings](https://vsmarketplacebadge.apphb.com/rating/vscode-icons-team.vscode-icons.svg)](https://marketplace.visualstudio.com/items?itemName=vscode-icons-team.vscode-icons)

[![Build Status](https://travis-ci.org/vscode-icons/vscode-icons.svg?branch=master)](https://travis-ci.org/vscode-icons/vscode-icons)
[![Build Status](https://ci.appveyor.com/api/projects/status/github/vscode-icons/vscode-icons?branch=master&svg=true)](https://ci.appveyor.com/project/vscode-icons-team/vscode-icons)

[![Dependencies Status](https://david-dm.org/vscode-icons/vscode-icons/status.svg)](https://david-dm.org/vscode-icons/vscode-icons)
[![DevDependencies Status](https://david-dm.org/vscode-icons/vscode-icons/dev-status.svg)](https://david-dm.org/vscode-icons/vscode-icons?type=dev)
[![Greenkeeper badge](https://badges.greenkeeper.io/vscode-icons/vscode-icons.svg)](https://greenkeeper.io/)

[![Maintainability](https://api.codeclimate.com/v1/badges/4f02368ebeb7be1490bb/maintainability)](https://codeclimate.com/github/vscode-icons/vscode-icons/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/4f02368ebeb7be1490bb/test_coverage)](https://codeclimate.com/github/vscode-icons/vscode-icons/test_coverage)
[![Known Vulnerabilities](https://snyk.io/test/github/vscode-icons/vscode-icons/badge.svg)](https://snyk.io/test/github/vscode-icons/vscode-icons)

[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/vscode-icons/vscode-icons.svg)](https://isitmaintained.com/project/vscode-icons/vscode-icons "Average time to resolve an issue")
[![Percentage of issues still open](https://isitmaintained.com/badge/open/vscode-icons/vscode-icons.svg)](https://isitmaintained.com/project/vscode-icons/vscode-icons "Percentage of issues still open")

[![Wallaby.js](https://img.shields.io/badge/wallaby.js-configured-green.svg)](https://wallabyjs.com)

---

Bring icons to your [Visual Studio Code](https://code.visualstudio.com/) (**minimum supported version: `1.31.1`**)

![demo](https://raw.githubusercontent.com/vscode-icons/vscode-icons/master/images/screenshot.gif)

---

## Installation

To install the extension just execute the following command:

```sh
ext install vscode-icons
```

Some people have reported that they cannot find the extension when they insert the installation command.

If you find yourself in the same position, try:

```sh
ext install icons
# or
ext install "vscode-icons"
```

## Security

`vscode-icons` utilizes [NSRI](https://www.npmjs.com/package/nsri) for its subresources integrity check and protection against code injection.

## Usage

Once installed and after reloading `vscode`, you will be presented with a message to `Activate` the icons.

In case this doesn't happen, navigate to:

* `Linux` & `Windows` `=>` **File > Preferences > File Icon Theme > VSCode Icons**.
* `MacOS` `=>` **Code > Preferences > File Icon Theme > VSCode Icons**.

## Features

`vscode-icons` is being shipped with a lot of features, like:

* [Icons Customization](https://github.com/vscode-icons/vscode-icons/wiki/Customization)
* [Project Auto-Detection](https://github.com/vscode-icons/vscode-icons/wiki/Pad)
* [Custom Configuration](https://github.com/vscode-icons/vscode-icons/wiki/Configuration)

## Globalization

`vscode-icons` uses [Crowdin](https://crowdin.com/project/vscode-icons-i18n) to provide translations for `vscode` supported languages.

We are looking for translators and proofreaders for all `vscode` supported languages.

If you'd like to contribute, checkout the [translation section](https://github.com/vscode-icons/vscode-icons/wiki/Translation).

## Contributing

If you like to get involved with the source code, checkout the [build section](https://github.com/vscode-icons/vscode-icons/wiki/Build).

For those using [Docker](https://www.docker.com/) checkout the [docker section](https://github.com/vscode-icons/vscode-icons/wiki/Docker).

On the other hand, if you want to show the world your artistic side, checkout the [contributing section](https://github.com/vscode-icons/vscode-icons/wiki/Contributing).

In any case, please follow our [contribution guidelines](https://github.com/vscode-icons/vscode-icons/blob/master/.github/CONTRIBUTING.md).

## Documentation

In our [wiki](https://github.com/vscode-icons/vscode-icons/wiki) you can find info, like:

* [Extension's History](https://github.com/vscode-icons/vscode-icons/wiki/History)
* [Supported file icons](https://github.com/vscode-icons/vscode-icons/wiki/ListOfFiles).
* [Supported folder icons](https://github.com/vscode-icons/vscode-icons/wiki/ListOfFolders).

and more.

## Credits

Kudos to all [contributors](https://github.com/vscode-icons/vscode-icons/graphs/contributors) that made this extension what it is.

## License

The source code is licensed under the [MIT](https://github.com/vscode-icons/vscode-icons/blob/master/License) license.

The icons are licensed under the [Creative Commons - ShareAlike (CC BY-SA)](https://creativecommons.org/licenses/by-sa/4.0/) license.

Branded icons are licensed under their copyright license.

## Versioning

`vscode-icons` follows [Semantic Versioning 2.0.0](http://semver.org/).

## Change Log

You can checkout all our changes in our [change log](https://github.com/vscode-icons/vscode-icons/blob/master/CHANGELOG.md).

## Acknowledgements

We like to express our "Special Thanks" to:

* The [Wallaby.js](https://wallabyjs.com) team for creating an **awesome** development tool and for their generosity in providing us with a license.

## Related extensions

* [vscode-icons for GitHub](https://github.com/dderevjanik/github-vscode-icons) by [@dderevjanik](https://github.com/dderevjanik) will allow you to see all `GitHub`'s files with `vscode-icons` icons.
* [vscode-icons-js](https://github.com/dderevjanik/vscode-icons-js) by [@dderevjanik](https://github.com/dderevjanik) get file/folder specific icon from `vscode-icons` icons.

**Enjoy!**
