Skip to content

Commit 89dda1d

Browse files
authored
readme-3 (#26)
1 parent fce50a1 commit 89dda1d

2 files changed

Lines changed: 78 additions & 99 deletions

File tree

CONTRIBUTING.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Pierre Theme
2+
3+
Light and dark themes for Visual Studio Code, Cursor, Zed, and Shiki. Built for [Diffs.com](https://diffs.com) by [The Pierre Computer Company](https://pierre.computer).
4+
5+
## Preview
6+
7+
![Pierre dark theme screenshot](https://github.com/user-attachments/assets/e8b2a6e0-995b-4515-997a-f805f4fbc5bf)
8+
![Pierre light theme screenshot](https://github.com/user-attachments/assets/2ebb09d0-eb42-4c28-9617-35873d96ed8f)
9+
10+
## Install
11+
12+
### Visual Studio Code
13+
14+
From the menu in Visual Studio Code:
15+
16+
- View > Extensions (or hit Command+Shift+X or Control+Shift+X)
17+
- Search for `Pierre Theme`
18+
- Click install
19+
20+
You can also install or download from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=pierrecomputer.pierre-theme).
21+
22+
### Cursor
23+
24+
From the menu in Cursor:
25+
26+
- View > Extensions (or hit Command+Shift+X or Control+Shift+X)
27+
- Search for `Pierre Theme`
28+
- Click install
29+
30+
You can also install or download from the [Open VSX registry](https://open-vsx.org/extension/pierrecomputer/pierre-theme).
31+
32+
### Zed
33+
34+
From the menu in Zed:
35+
36+
- Zed > Extensions (or hit Command+Shift+X or Control+Shift+X)
37+
- Search for `Pierre`
38+
- Click install
39+
40+
## Vibrant themes (Display P3)
41+
42+
> [!NOTE]
43+
> Vibrant themes do not work in VS Code or Cursor at this time as it does not support color formats other than Hex or RGB. You can, however, use these with [Diffs](https://diffs.com) or any [Shiki](https://shiki.style) project to render code.
44+
45+
The **Vibrant** theme variants use CSS's `color(display-p3 r g b)` format with enhanced saturation to fully utilize Display P3's wider color gamut. Display P3 can represent ~25% more colors than standard sRGB, and these themes are optimized to take full advantage of that on compatible displays.
46+
47+
The conversion algorithm transforms sRGB colors to Display P3 through proper linear color space transformations, then enhances saturation (15-30%) and luminance (5% for vibrant colors) to push colors into the wider P3 gamut that isn't accessible in sRGB.
48+
49+
## Override
50+
51+
To override this (or any other) theme in your personal config file, please follow the guide in the [color theme](https://code.visualstudio.com/api/extension-guides/color-theme) documentation. This is handy for small tweaks to the theme without having to fork and maintain your own theme.
52+
53+
## Contribute
54+
55+
1. Clone and open this [repo](https://github.com/pierrecomputer/theme) in your editor
56+
2. Run `npm install` to install the dependencies.
57+
3. Press `F5` to open a new window with your extension loaded
58+
4. Open `Code > Preferences > Color Theme` [`⌘k ⌘t`] and pick the "Pierre…" theme you want to test.
59+
5. Make changes to the [`/src/theme.ts`](https://github.com/pierrecomputer/theme/blob/main/src/theme.ts) file.
60+
6. Run `npm run build` to update the theme. You can also run `npm run start` instead to automatically rebuild the theme while making changes and no reloading should be necessary.
61+
7. Run `npm test` to validate your changes (this runs automatically on PRs).
62+
8. Once you're happy, commit your changes and open a PR.
63+
64+
## Scripts
65+
66+
| Script | Description |
67+
| --- | --- |
68+
| `npm run build` | Builds the theme `.json` files in `./themes` directory |
69+
| `npm test` | Runs validation tests on the theme (includes build) |
70+
| `npm run package` | Compiles the theme `.vsix` file at the project root |
71+
| `npm start` | Automatically runs build on file change |
72+
73+
## Credit
74+
75+
This theme was built on top of [GitHub's Visual Studio Code Theme](https://github.com/primer/github-vscode-theme). All credit to them for the technique and build tooling, which we've since iterated on for more specific language tokens.

README.md

Lines changed: 3 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
![Pierre dark theme screenshot](https://github.com/user-attachments/assets/e8b2a6e0-995b-4515-997a-f805f4fbc5bf)
2-
31
```
42
PIERRE COMPUTER COMPANY █
53
PROJECT: THEME
@@ -13,100 +11,6 @@ OPEN POSITIONS: [Systems Engineer](https://pierre.computer/careers/systems-engin
1311
1412
~~~
1513
16-
## Project Overview
17-
18-
Light and dark themes for Visual Studio Code, Cursor, Zed, and Shiki. Built
19-
for [Diffs.com](https://diffs.com)
20-
by [The Pierre Computer Company](https://pierre.computer).
21-
22-
## Install
23-
24-
### Visual Studio Code
25-
26-
From the menu in Visual Studio Code:
27-
28-
- View > Extensions (or hit Command+Shift+X or Control+Shift+X)
29-
- Search for `Pierre Theme`
30-
- Click install
31-
32-
You can also install or download from the
33-
[Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=pierrecomputer.pierre-theme).
34-
35-
### Cursor
36-
37-
From the menu in Cursor:
38-
39-
- View > Extensions (or hit Command+Shift+X or Control+Shift+X)
40-
- Search for `Pierre Theme`
41-
- Click install
42-
43-
You can also install or download from the
44-
[Open VSX registry](https://open-vsx.org/extension/pierrecomputer/pierre-theme).
45-
46-
### Zed
47-
48-
From the menu in Zed:
49-
50-
- Zed > Extensions (or hit Command+Shift+X or Control+Shift+X)
51-
- Search for `Pierre`
52-
- Click install
53-
54-
## Vibrant themes (Display P3)
55-
56-
> [!NOTE]
57-
> Vibrant themes do not work in VS Code or Cursor at this time as it does not
58-
> support color formats other than Hex or RGB. You can, however, use these
59-
> with [Diffs](https://diffs.com) or any [Shiki](https://shiki.style) project
60-
> to render code.
61-
62-
The **Vibrant** theme variants use CSS's `color(display-p3 r g b)` format with
63-
enhanced saturation to fully utilize Display P3's wider color gamut. Display
64-
P3 can represent ~25% more colors than standard sRGB, and these themes are
65-
optimized to take full advantage of that on compatible displays.
66-
67-
The conversion algorithm transforms sRGB colors to Display P3 through proper
68-
linear color space transformations, then enhances saturation (15-30%) and
69-
luminance (5% for vibrant colors) to push colors into the wider P3 gamut that
70-
isn't accessible in sRGB.
71-
72-
## Override
73-
74-
To override this (or any other) theme in your personal config file, please
75-
follow the guide in the
76-
[color theme](https://code.visualstudio.com/api/extension-guides/color-theme)
77-
documentation. This is handy for small tweaks to the theme without having to
78-
fork and maintain your own theme.
79-
80-
## Contribute
81-
82-
1. Clone and open this [repo](https://github.com/pierrecomputer/theme) in your
83-
editor
84-
2. Run `npm install` to install the dependencies.
85-
3. Press `F5` to open a new window with your extension loaded
86-
4. Open `Code > Preferences > Color Theme` [`⌘k ⌘t`] and pick the
87-
"Pierre…" theme you want to test.
88-
5. Make changes to the
89-
[`/src/theme.ts`](https://github.com/pierrecomputer/theme/blob/main/src/theme.ts)
90-
file.
91-
6. Run `npm run build` to update the theme. You can also run `npm run start`
92-
instead to automatically rebuild the theme while making changes and no
93-
reloading should be necessary.
94-
7. Run `npm test` to validate your changes (this runs automatically on PRs).
95-
8. Once you're happy, commit your changes and open a PR.
96-
97-
## Scripts
98-
99-
| Script | Description |
100-
| --- | --- |
101-
| `npm run build` | Builds the theme `.json` files in `./themes` directory |
102-
| `npm test` | Runs validation tests on the theme (includes build) |
103-
| `npm run package` | Compiles the theme `.vsix` file at the project root |
104-
| `npm start` | Automatically runs build on file change |
105-
106-
## Credit
107-
108-
This theme was built on top of
109-
[GitHub's Visual Studio Code Theme](https://github.com/primer/github-vscode-theme).
110-
All credit to them for the technique and build tooling, which we've since
111-
iterated on for more specific language tokens.
112-
```
14+
Overview:
15+
- Light and dark themes for Visual Studio Code, Cursor, Zed, and Shiki.
16+
- Built for [Diffs.com](https://diffs.com)

0 commit comments

Comments
 (0)