Skip to content

Commit

Permalink
docs: add readme and contributing (#2)
Browse files Browse the repository at this point in the history
* docs: add basic readme

* docs: add contributing guidelines
  • Loading branch information
kettanaito authored Mar 22, 2022
1 parent 73b0a4e commit 3164d3e
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 13 deletions.
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Contributing

Thank you for deciding to contribute to our Visual Studio Code Theme! Please read through the page below that will take you through everything you need to know to land your first contribution. See you in the pull requests!

## Development

### Create a fork

First, create a fork (your own copy) of this repository by clicking on the "Fork" button in the upper right corner of this page.

### Clone

```sh
git clone <YOUR_FORK_URL>
cd vscode-theme
```

### Install locally

To use this extension locally, it must be copied to the Visual Studio Code Extensions folder on your machine.

#### Copy automatically

Use the following command to do that:

```sh
./sync.sh
```

#### Copy manually

```sh
cd vscode-theme
cp -r . ~/.vscode/extensions/codesandbox-theme
```

### Preview

It's always more pleasant to develop when you see your changes take effect in real time. Below you can find the instructions on how to preview your local version of this theme.

1. Open the repository in Visual Studio Code.
1. Click <kbd>F5</kbd> to switch to the "Debugger" section.
1. Click on the "Play" button to run the theme in a separate extension window.
1. In the newly opened VS Code window, press <kbd>CMD + SHIFT + P</kbd>, then type "Color Theme".
1. Choose "CodeSandbox" from the themes list. If you don't see this option in the list, please make sure to [have installed the theme locally](#install-locally).

Editing the theme files under `./themes` will update the running extension window automatically.
35 changes: 22 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@
# CodeSandbox theme
<h1 align="center">CodeSandbox Theme</h1>
<p align="center">An official CodeSandbox theme for Visual Studio Code.</p>

## Development
## Install

### Install locally
Install this syntax theme [from the Marketplace](https://marketplace.visualstudio.com/items?itemName=CodeSandbox-io.codesandbox-theme).

To use this extension locally, it must be copied to the VS Code Extensions folder on your machine. Use the shorthand command below to do that:
## Recommendations

```sh
./sync.sh
Bring your Visual Studio Code even closer to the look and feel of CodeSandbox with these suggestions for your `settings.json`:

```json
{
"editor.fontSize": 14,
"editor.fontFamily": "'Fira Code'",
"editor.fontLigatures": true
}
```

### Preview
You can find the [Fira Code font](https://github.com/tonsky/FiraCode) on GitHub.

## Extension

While this theme brings the aesthetics of your editor to match that at CodeSandbox, you can enhance your development workflow as well with the live following, —all through our official Visual Studio Code extension.

> Check out our [CodeSandbox Projects extension](https://marketplace.visualstudio.com/items?itemName=CodeSandbox-io.codesandbox-projects) to have the power of CodeSandbox right in your editor!
1. Open the repository in Visual Studio Code.
1. Click <kbd>F5</kbd> to switch to the "Debugger" section.
1. Click on the "Play" button to run the theme in a separate extension window.
1. In the newly opened VS Code window, press <kbd>CMD+SHIFT+P</kbd>, then type "Color Theme".
1. Choose "CodeSandbox" from the themes list. If you don't see this option in the list, please make sure to [have installed the theme locally](#install-locally).
## Contribute

Editing the theme files under `./themes` will update the running extension window automatically.
Found an issue? Would like to propose an improvement? Please follow our [Contribution guidelines](CONTRIBUTING.md) to make those changes happen. Thank you!

0 comments on commit 3164d3e

Please sign in to comment.