chore: Update readme
This commit is contained in:
Mattia Astorino
parent
05c2a1fe99
commit
7938c8ca3c
1 changed files with 66 additions and 17 deletions
79
README.md
79
README.md
|
|
@ -2,36 +2,83 @@
|
|||
<p align="center"><img width="620px" src="http://i.imgur.com/77xXWrA.jpg"/></p>
|
||||
<p align="center"><img width="450px" src="http://i.imgur.com/JXb5aRO.jpg"></p>
|
||||
|
||||
[](https://github.com/equinusocio/vsc-material-theme/releases) [](https://github.com/equinusocio/vsc-material-theme/issues) [](https://beerpay.io/equinusocio/vsc-material-theme)
|
||||
[](https://github.com/equinusocio/vsc-material-theme/releases) [](https://github.com/equinusocio/vsc-material-theme/issues)
|
||||
<a href="https://code.visualstudio.com/updates/v1_12"><img src="https://img.shields.io/badge/VS_Code-v1.12+-373277.svg?style=flat-square"/></a> <a href="https://marketplace.visualstudio.com/items?itemName=Equinusocio.vsc-material-theme"><img src="http://vsmarketplacebadge.apphb.com/installs/Equinusocio.vsc-material-theme.svg?style=flat-square"/></a> <a href="https://marketplace.visualstudio.com/items/Equinusocio.vsc-material-theme"><img src="http://vsmarketplacebadge.apphb.com/rating-short/Equinusocio.vsc-material-theme.svg?style=flat-square"/></a> [](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)
|
||||
|
||||
<!-- TOC -->
|
||||
|
||||
- [Getting started](#getting-started)
|
||||
- [Installation](#installation)
|
||||
- [Activate the theme](#activate-the-theme)
|
||||
- [Activate File Icons Theme](#activate-file-icons-theme)
|
||||
- [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)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
# 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 <kbd>cmd/ctrl</kbd> + <kbd>P</kbd>
|
||||
2. Type `ext install vsc-material-theme`
|
||||
|
||||
## Installation
|
||||
|
||||
Launch *Quick Open*
|
||||
- <img src="https://www.kernel.org/theme/images/logos/favicon.png" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-linux.pdf">Linux</a> `Ctrl+P`
|
||||
- <img src="https://developer.apple.com/favicon.ico" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-macos.pdf">macOS</a> `⌘P`
|
||||
- <img src="https://www.microsoft.com/favicon.ico" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf">Windows</a> `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:
|
||||
- <img src="https://www.kernel.org/theme/images/logos/favicon.png" width=16 height=16/> **Linux** `~/.vscode/extensions`
|
||||
- <img src="https://developer.apple.com/favicon.ico" width=16 height=16/> **macOs** `~/.vscode/extensions`
|
||||
- <img src="https://www.microsoft.com/favicon.ico" width=16 height=16/> **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 <kbd>cmd/ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> 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*,
|
||||
- <img src="https://www.kernel.org/theme/images/logos/favicon.png" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-linux.pdf">Linux</a> `Ctrl+P`
|
||||
- <img src="https://developer.apple.com/favicon.ico" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-macos.pdf">macOS</a> `Shift+⌘+P`
|
||||
- <img src="https://www.microsoft.com/favicon.ico" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf">Windows</a> `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 <kbd>cmd/ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> 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*,
|
||||
- <img src="https://www.kernel.org/theme/images/logos/favicon.png" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-linux.pdf">Linux</a> `Ctrl+P`
|
||||
- <img src="https://developer.apple.com/favicon.ico" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-macos.pdf">macOS</a> `Shift+⌘+P`
|
||||
- <img src="https://www.microsoft.com/favicon.ico" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf">Windows</a> `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:
|
||||
# Acknowledgements
|
||||
- [@balanceiskey](https://github.com/balanceiskey) for the theme builder.
|
||||
|
||||
|
||||
<p align="center"> <img src="https://equinusocio.gallerycdn.vsassets.io/extensions/equinusocio/vsc-material-theme/0.0.14/1494970083238/Microsoft.VisualStudio.Services.Icons.Default" width=16 height=16/> Copyright © 2017 Mattia Astorino</p>
|
||||
|
|
|
|||
Loading…
Reference in a new issue