Skip to content

Commit 0bf5569

Browse files
committed
seti: use CONTRIBUTING
1 parent c3e2c76 commit 0bf5569

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

Diff for: extensions/theme-seti/.vscodeignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
build/**
22
cgmanifest.json
33
icons/preview.html
4+
CONTRIBUTING.md

Diff for: extensions/theme-seti/CONTRIBUTING.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# theme-seti
2+
3+
This is an icon theme that uses the icons from [`seti-ui`](https://github.com/jesseweed/seti-ui).
4+
5+
## Updating icons
6+
7+
There is script that can be used to update icons, [./build/update-icon-theme.js](build/update-icon-theme.js).
8+
9+
To run this script, run `npm run update` from the `theme-seti` directory.
10+
11+
This can be run in one of two ways: looking at a local copy of `seti-ui` for icons, or getting them straight from GitHub.
12+
13+
If you want to run it from a local copy of `seti-ui`, first clone [`seti-ui`](https://github.com/jesseweed/seti-ui) to the folder next to your `vscode` repo (from the `theme-seti` directory, `../../`).
14+
Then, inside the `set-ui` directory, run `npm install` followed by `npm run prepublishOnly`. This will generate updated icons.
15+
16+
If you want to download the icons straight from GitHub, change the `FROM_DISK` variable to `false` inside of `update-icon-theme.js`.
17+
18+
### Languages not shipped with `vscode`
19+
20+
Languages that are not shipped with `vscode` must be added to the `nonBuiltInLanguages` object inside of `update-icon-theme.js`.
21+
22+
These should match [the file mapping in `seti-ui`](https://github.com/jesseweed/seti-ui/blob/master/styles/components/icons/mapping.less).
23+
24+
Please try and keep this list in alphabetical order! Thank you.
25+
26+
## Previewing icons
27+
28+
There is a [`./icons/preview.html`](./icons/preview.html) file that can be opened to see all of the icons included in the theme.
29+
Note that to view this, it needs to be hosted by a web server.
30+
31+
When updating icons, it is always a good idea to make sure that they work properly by looking at this page.
32+
When submitting a PR that updates these icons, a screenshot of the preview page should accompany it.

0 commit comments

Comments
 (0)