Skip to content

Commit

Permalink
Doc: Setup guide
Browse files Browse the repository at this point in the history
  • Loading branch information
gerardroche committed Aug 27, 2017
1 parent 316dc9d commit 0ef9bd1
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 8 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt

* Added: Switch Project command
* Added: Remove Folder command
* Doc: Setup guide

### Deprecated

Expand Down
32 changes: 24 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,34 @@ Add, open, remove, switch, and manage projects and folders, using the command pa

[![Minimum Sublime Version](https://img.shields.io/badge/sublime-%3E%3D%203.0-brightgreen.svg?style=flat-square)](https://sublimetext.com) [![Latest Stable Version](https://img.shields.io/github/tag/gerardroche/sublime-open-sesame.svg?style=flat-square&label=stable)](https://github.com/gerardroche/sublime-open-sesame/tags) [![GitHub stars](https://img.shields.io/github/stars/gerardroche/sublime-open-sesame.svg?style=flat-square)](https://github.com/gerardroche/sublime-open-sesame/stargazers) [![Downloads](https://img.shields.io/packagecontrol/dt/open-sesame.svg?style=flat-square)](https://packagecontrol.io/packages/open-sesame) [![Author](https://img.shields.io/badge/twitter-gerardroche-blue.svg?style=flat-square)](https://twitter.com/gerardroche)


Set the location of your projects:

`Preferences > Settings`

```json
{
"open-sesame.path": "~/projects"
}
```

![Command palette screenshot](screenshot-a.png)

Adding, opening, or switching a project will prompt an overlay for you to select a project.

By default your projects are listed in the format `your/project`.

![Overlay screenshot](screenshot-b.png)

## OVERVIEW
If you prefer to organise your projects at a single level then set the depth to `1`:

`Preferences > Settings`

* [Installation](#installation)
* [Commands](#commands)
* [Keybindings](#key-bindings)
* [Configuration](#configuration)
* [Contributing](#contributing)
* [Changelog](#changelog)
* [License](#license)
```json
{
"open-sesame.depth": 1
}
```

## INSTALLATION

Expand Down
Binary file modified screenshot-a.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0ef9bd1

Please sign in to comment.