Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 39 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@ OPEN POSITIONS: [Systems Engineer](https://pierre.computer/careers/systems-engin

~~~

## Project Overview

# Pierre Theme

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).
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).

## Install

Expand All @@ -28,7 +29,8 @@ From the menu in Visual Studio Code:
- Search for `Pierre Theme`
- Click install

You can also install or download from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=pierrecomputer.pierre-theme).
You can also install or download from the
[Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=pierrecomputer.pierre-theme).

### Cursor

Expand All @@ -38,7 +40,8 @@ From the menu in Cursor:
- Search for `Pierre Theme`
- Click install

You can also install or download from the [Open VSX registry](https://open-vsx.org/extension/pierrecomputer/pierre-theme).
You can also install or download from the
[Open VSX registry](https://open-vsx.org/extension/pierrecomputer/pierre-theme).

### Zed

Expand All @@ -51,24 +54,43 @@ From the menu in Zed:
## Vibrant themes (Display P3)

> [!NOTE]
> 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.
> 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.

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.
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.

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.
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.

## Override

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.
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.

## Contribute

1. Clone and open this [repo](https://github.com/pierrecomputer/theme) in your editor
1. Clone and open this [repo](https://github.com/pierrecomputer/theme) in your
editor
2. Run `npm install` to install the dependencies.
3. Press `F5` to open a new window with your extension loaded
4. Open `Code > Preferences > Color Theme` [`⌘k ⌘t`] and pick the "Pierre…" theme you want to test.
5. Make changes to the [`/src/theme.ts`](https://github.com/pierrecomputer/theme/blob/main/src/theme.ts) file.
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.
4. Open `Code > Preferences > Color Theme` [`⌘k ⌘t`] and pick the
"Pierre…" theme you want to test.
5. Make changes to the
[`/src/theme.ts`](https://github.com/pierrecomputer/theme/blob/main/src/theme.ts)
file.
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.
7. Run `npm test` to validate your changes (this runs automatically on PRs).
8. Once you're happy, commit your changes and open a PR.

Expand All @@ -83,5 +105,8 @@ To override this (or any other) theme in your personal config file, please follo

## Credit

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.
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.
```