From 4fcbe0e6563076527153c32d5ce16480414a5227 Mon Sep 17 00:00:00 2001 From: fat Date: Fri, 6 Feb 2026 14:03:03 -0800 Subject: [PATCH] readme-3 --- CONTRIBUTING.md | 75 +++++++++++++++++++++++++++++++++++ README.md | 102 ++---------------------------------------------- 2 files changed, 78 insertions(+), 99 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..92153d2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,75 @@ +# 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). + +## Preview + +![Pierre dark theme screenshot](https://github.com/user-attachments/assets/e8b2a6e0-995b-4515-997a-f805f4fbc5bf) +![Pierre light theme screenshot](https://github.com/user-attachments/assets/2ebb09d0-eb42-4c28-9617-35873d96ed8f) + +## Install + +### Visual Studio Code + +From the menu in Visual Studio Code: + +- View > Extensions (or hit Command+Shift+X or Control+Shift+X) +- 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). + +### Cursor + +From the menu in Cursor: + +- View > Extensions (or hit Command+Shift+X or Control+Shift+X) +- 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). + +### Zed + +From the menu in Zed: + +- Zed > Extensions (or hit Command+Shift+X or Control+Shift+X) +- Search for `Pierre` +- Click install + +## 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. + +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. + +## 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. + +## Contribute + +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. +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. + +## Scripts + +| Script | Description | +| --- | --- | +| `npm run build` | Builds the theme `.json` files in `./themes` directory | +| `npm test` | Runs validation tests on the theme (includes build) | +| `npm run package` | Compiles the theme `.vsix` file at the project root | +| `npm start` | Automatically runs build on file change | + +## 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. diff --git a/README.md b/README.md index 682bb50..c67a275 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -![Pierre dark theme screenshot](https://github.com/user-attachments/assets/e8b2a6e0-995b-4515-997a-f805f4fbc5bf) - ``` PIERRE COMPUTER COMPANY █ PROJECT: THEME @@ -13,100 +11,6 @@ OPEN POSITIONS: [Systems Engineer](https://pierre.computer/careers/systems-engin ~~~ -## Project Overview - -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 - -### Visual Studio Code - -From the menu in Visual Studio Code: - -- View > Extensions (or hit Command+Shift+X or Control+Shift+X) -- 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). - -### Cursor - -From the menu in Cursor: - -- View > Extensions (or hit Command+Shift+X or Control+Shift+X) -- 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). - -### Zed - -From the menu in Zed: - -- Zed > Extensions (or hit Command+Shift+X or Control+Shift+X) -- Search for `Pierre` -- Click install - -## 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. - -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. - -## 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. - -## Contribute - -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. -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. - -## Scripts - -| Script | Description | -| --- | --- | -| `npm run build` | Builds the theme `.json` files in `./themes` directory | -| `npm test` | Runs validation tests on the theme (includes build) | -| `npm run package` | Compiles the theme `.vsix` file at the project root | -| `npm start` | Automatically runs build on file change | - -## 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. -``` +Overview: + - Light and dark themes for Visual Studio Code, Cursor, Zed, and Shiki. + - Built for [Diffs.com](https://diffs.com)