diff --git a/README.md b/README.md index 8a276a2..c039857 100644 --- a/README.md +++ b/README.md @@ -2,36 +2,83 @@

-[![GitHub tag](https://img.shields.io/github/release/equinusocio/vsc-material-theme.svg?style=flat-square)](https://github.com/equinusocio/vsc-material-theme/releases) [![GitHub tag](https://img.shields.io/github/issues/equinusocio/vsc-material-theme.svg?style=flat-square)](https://github.com/equinusocio/vsc-material-theme/issues) [![Beerpay](https://beerpay.io/equinusocio/vsc-material-theme/badge.svg?style=beer)](https://beerpay.io/equinusocio/vsc-material-theme) +[![GitHub tag](https://img.shields.io/github/release/equinusocio/vsc-material-theme.svg?style=flat-square)](https://github.com/equinusocio/vsc-material-theme/releases) [![GitHub tag](https://img.shields.io/github/issues/equinusocio/vsc-material-theme.svg?style=flat-square)](https://github.com/equinusocio/vsc-material-theme/issues) + [![Beerpay](https://beerpay.io/equinusocio/vsc-material-theme/badge.svg?style=beer)](https://beerpay.io/equinusocio/vsc-material-theme) + The most epic theme meet Visual Studio Code. Please note that this theme is still in Beta (β) release. You can help by reporting issues [here](https://github.com/equinusocio/vsc-material-theme/issues) -- [Installation](#installation) -- [Activate the theme](#activate-the-theme) -- [Activate File Icons Theme](#activate-file-icons-theme) +- [Getting started](#getting-started) + - [Installation](#installation) + - [Packaged VSIX Extension](#packaged-vsix-extension) + - [GitHub Repository Clone](#github-repository-clone) + - [Activate theme](#activate-theme) + - [Activate File Icons](#activate-file-icons) - [Recommended settings for a better experience:](#recommended-settings-for-a-better-experience) - [Other resources](#other-resources) -- [Thanks](#thanks) +- [Acknowledgements](#acknowledgements) -# Installation +# Getting started You can install this awesome theme through the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Equinusocio.vsc-material-theme). -1. Press cmd/ctrl + P -2. Type `ext install vsc-material-theme` + +## Installation + +Launch *Quick Open* + - Linux `Ctrl+P` + - macOS `⌘P` + - Windows `Ctrl+P` + +Paste the following command and press `Enter`: +```shell +ext install vsc-material-theme +``` + +#### Packaged VSIX Extension + +[Download the latest .vsix release](https://github.com/equinusocio/vsc-material-theme/releases/latest) file from the GitHub repository and install it from the command line +```shell +code --install-extension vsc-material-theme-*.*.*.vsix +``` +or from within VS Code by launching *Quick Open* and running the *Install from VSIX...* command. + +##### GitHub Repository Clone + +Change to your `.vscode/extensions` [VS Code extensions directory](https://code.visualstudio.com/docs/extensions/install-extension#_side-loading). +Depending on your platform it is located in the following folders: + - **Linux** `~/.vscode/extensions` + - **macOs** `~/.vscode/extensions` + - **Windows** `%USERPROFILE%\.vscode\extensions` + +Clone the Nord repository as `nord-visual-studio-code`: +```shell +git clone https://github.com/equinusocio/vsc-material-theme.git Equinusocio.vsc-material-theme +``` -# Activate the theme +## Activate theme -1. Press cmd/ctrl + Shift + P and type `color`, then select **Color Theme** -2. Type `Material Theme` and select one of the theme color from the list, then press **Enter** +Launch *Quick Open*, + - Linux `Ctrl+P` + - macOS `Shift+⌘+P` + - Windows `Ctrl+P` -# Activate File Icons Theme +run the `Preferences: Color Theme` command and select one of the `Material Theme` themes from the drop-down menu. -1. Press cmd/ctrl + Shift + P and type `icon theme`, then select **File Icon Theme** -2. Select `Material Theme Icons` from the list, then press **Enter** +The color theme drop-down can alternatively be opened via *File* (*Code* on macOS) > *Preferences* > *Color Theme*. + + +## Activate File Icons + +Launch *Quick Open*, + - Linux `Ctrl+P` + - macOS `Shift+⌘+P` + - Windows `Ctrl+P` + +run the `icon theme` command and select `Material Theme Icons` from the drop-down menu. # Recommended settings for a better experience: @@ -47,6 +94,8 @@ You can install this awesome theme through the [Visual Studio Code Marketplace]( # Other resources - **AppIcon:** [Download](https://github.com/equinusocio/vsc-material-theme/files/989048/vsc-material-theme-appicon.zip) the official Material Theme app icon for Visual Studio code -# Thanks -Thanks to: -- [@balanceiskey](https://github.com/balanceiskey) for the theme builder. \ No newline at end of file +# Acknowledgements +- [@balanceiskey](https://github.com/balanceiskey) for the theme builder. + + +

Copyright © 2017 Mattia Astorino