chore: Update README
This commit is contained in:
Mattia Astorino
parent
3faf54ebdf
commit
ba969ccd3e
5 changed files with 2354 additions and 6580 deletions
53
README.md
53
README.md
|
|
@ -9,6 +9,24 @@
|
|||
|
||||
The most epic theme meets Visual Studio Code. You can help by reporting issues [here](https://github.com/equinusocio/vsc-material-theme/issues)
|
||||
|
||||
<!-- TOC -->
|
||||
|
||||
- [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)
|
||||
- [Set the accent color](#set-the-accent-color)
|
||||
- [Override theme colors](#override-theme-colors)
|
||||
- [Recommended settings for a better experience](#recommended-settings-for-a-better-experience)
|
||||
- [Other resources](#other-resources)
|
||||
- [Contributors](#contributors)
|
||||
- [Backers](#backers)
|
||||
- [Sponsors](#sponsors)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
# Getting started
|
||||
|
||||
You can install this awesome theme through the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Equinusocio.vsc-material-theme).
|
||||
|
|
@ -26,7 +44,7 @@ Paste the following command and press `Enter`:
|
|||
ext install vsc-material-theme
|
||||
```
|
||||
|
||||
#### Packaged VSIX Extension <sup>[↑](#getting-started)</sup>
|
||||
#### 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
|
||||
|
||||
|
|
@ -36,7 +54,7 @@ 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 <sup>[↑](#getting-started)</sup>
|
||||
##### 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:
|
||||
|
|
@ -52,7 +70,7 @@ git clone https://github.com/equinusocio/vsc-material-theme.git Equinusocio.vsc-
|
|||
```
|
||||
|
||||
|
||||
## Activate theme <sup>[↑](#getting-started)</sup>
|
||||
## Activate theme
|
||||
|
||||
Launch *Quick Open*,
|
||||
|
||||
|
|
@ -64,7 +82,7 @@ Type `theme` and choose `Preferences: Color Theme`, then select Material Theme f
|
|||
|
||||
This theme provides different color variants, to change the active theme variant type `Material Theme` and choose `Material Theme: Settings`, then select `Change color variant` and pick one theme from the list.
|
||||
|
||||
## Activate File Icons <sup>[↑](#getting-started)</sup>
|
||||
## Activate File Icons
|
||||
|
||||
Launch *Quick Open*,
|
||||
|
||||
|
|
@ -84,10 +102,28 @@ Launch *Quick Open*,
|
|||
|
||||
Type `Material Theme` and choose `Material Theme: Settings`, then select `Change accent color` and pick one color from the list.
|
||||
|
||||
## Override theme colors
|
||||
You can override the material theme ui and schemes colors by adding these theme-specific settings to your configuration.
|
||||
|
||||
# Recommended settings for a better experience <sup>[↑](#getting-started)</sup>
|
||||
```js
|
||||
"editor.tokenColorCustomizations": {
|
||||
"[Material Theme]": {
|
||||
"comments": "#229977"
|
||||
},
|
||||
"..."
|
||||
},
|
||||
"workbench.colorCustomizations": {
|
||||
"[Material Theme]": {
|
||||
"sideBar.background": "#347890"
|
||||
},
|
||||
"..."
|
||||
}
|
||||
```
|
||||
|
||||
```json
|
||||
# Recommended settings for a better experience
|
||||
|
||||
```js
|
||||
{
|
||||
// Controls the font family.
|
||||
"editor.fontFamily": "Operator Mono",
|
||||
// Controls the line height. Use 0 to compute the lineHeight from the fontSize.
|
||||
|
|
@ -95,10 +131,11 @@ Type `Material Theme` and choose `Material Theme: Settings`, then select `Change
|
|||
// Enables font ligatures
|
||||
"editor.fontLigatures": true,
|
||||
// Controls if file decorations should use badges.
|
||||
"explorer.decorations.badges": false,
|
||||
"explorer.decorations.badges": false
|
||||
}
|
||||
```
|
||||
|
||||
# Other resources <sup>[↑](#getting-started)</sup>
|
||||
# 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
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@
|
|||
"_folder_ci_open"
|
||||
],
|
||||
"changelog": {
|
||||
"lastversion": "1.2.0"
|
||||
"lastversion": "1.3.0"
|
||||
},
|
||||
"icons": {
|
||||
"theme": {
|
||||
|
|
|
|||
3498
package-lock.json
generated
3498
package-lock.json
generated
File diff suppressed because it is too large
Load diff
50
package.json
50
package.json
|
|
@ -25,12 +25,12 @@
|
|||
"vscode": "^1.19.0"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "npm run build-icons && npm run build-themes && npm run build-icons-accents && npm run build-icons-variants",
|
||||
"minimize-icons": "svgo -f src/icons/svgs -o icons",
|
||||
"minimize-json": "json-minify themes/.material-theme-icons.tmp > themes/Material-Theme-Icons.json && npm run remove-icons-tmp",
|
||||
"remove-icons": "rimraf icons && rimraf themes/Material-Theme-Icons.json",
|
||||
"build": "yarn build-icons && yarn build-themes && yarn build-icons-accents && yarn build-icons-variants",
|
||||
"minimize-icons": "svgo -f src/icons/svgs -o icons/",
|
||||
"minimize-json": "json-minify themes/.material-theme-icons.tmp > themes/Material-Theme-Icons.json && yarn remove-icons-tmp",
|
||||
"remove-icons": "rimraf icons/* && rimraf themes/Material-Theme-Icons.json",
|
||||
"remove-icons-tmp": "rimraf themes/.material-theme-icons.tmp",
|
||||
"build-icons": "npm run remove-icons && npm run minimize-icons && yarn gulp build:icons && npm run minimize-json",
|
||||
"build-icons": "yarn remove-icons && yarn minimize-icons && yarn gulp build:icons && yarn minimize-json",
|
||||
"build-icons-accents": "yarn gulp build:icons.accents",
|
||||
"build-icons-variants": "yarn gulp build:icons.variants",
|
||||
"build-themes": "yarn gulp build:themes",
|
||||
|
|
@ -71,7 +71,7 @@
|
|||
"themes": [
|
||||
{
|
||||
"label": "Material Theme",
|
||||
"path": "./themes/Material-Theme-Default.json",
|
||||
"path": "./themes/Material-Theme-Palenight.json",
|
||||
"uiTheme": "vs-dark"
|
||||
}
|
||||
],
|
||||
|
|
@ -91,37 +91,37 @@
|
|||
}
|
||||
],
|
||||
"devDependencies": {
|
||||
"@types/chalk": "0.4.31",
|
||||
"@types/gulp": "4.0.4",
|
||||
"@types/gulp-if": "0.0.31",
|
||||
"@types/gulp-util": "3.0.31",
|
||||
"@types/mustache": "0.8.29",
|
||||
"@types/run-sequence": "0.0.29",
|
||||
"@types/chalk": "2.2.0",
|
||||
"@types/gulp": "4.0.5",
|
||||
"@types/gulp-if": "0.0.33",
|
||||
"@types/gulp-util": "3.0.34",
|
||||
"@types/mustache": "0.8.30",
|
||||
"@types/run-sequence": "0.0.30",
|
||||
"@types/through2": "2.0.33",
|
||||
"@types/yamljs": "0.2.30",
|
||||
"@types/yargs": "6.6.0",
|
||||
"babel-core": "6.25.0",
|
||||
"@types/yargs": "10.0.1",
|
||||
"babel-core": "6.26.0",
|
||||
"babel-preset-es2015": "6.24.1",
|
||||
"babel-root-import": "4.1.8",
|
||||
"cpx": "1.5.0",
|
||||
"eslint": "4.1.1",
|
||||
"eslint": "4.17.0",
|
||||
"eslint-plugin-standard": "3.0.1",
|
||||
"gulp": "3.9.1",
|
||||
"gulp-bump": "2.7.0",
|
||||
"gulp-conventional-changelog": "1.1.3",
|
||||
"gulp-bump": "3.1.0",
|
||||
"gulp-conventional-changelog": "1.1.11",
|
||||
"gulp-if": "2.0.2",
|
||||
"gulp-stats": "0.0.4",
|
||||
"gulp-util": "3.0.8",
|
||||
"json-minify": "1.0.0",
|
||||
"mustache": "2.3.0",
|
||||
"rimraf": "2.6.1",
|
||||
"run-sequence": "1.2.2",
|
||||
"standard-version": "4.2.0",
|
||||
"svgo": "0.7.1",
|
||||
"typescript": "2.4.1",
|
||||
"vscode": "1.1.1",
|
||||
"rimraf": "2.6.2",
|
||||
"run-sequence": "2.2.1",
|
||||
"standard-version": "4.3.0",
|
||||
"svgo": "1.0.4",
|
||||
"typescript": "2.7.1",
|
||||
"vscode": "1.1.10",
|
||||
"yamljs": "0.3.0",
|
||||
"yargs": "8.0.2"
|
||||
"yargs": "11.0.0"
|
||||
},
|
||||
"__metadata": {
|
||||
"id": "dffaf5a1-2219-434b-9d87-cb586fd59260",
|
||||
|
|
@ -136,4 +136,4 @@
|
|||
"url": "https://opencollective.com/vsc-material-theme",
|
||||
"logo": "https://opencollective.com/opencollective/logo.txt"
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue